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 

[primecoder]

Hi Team,

the Websocket Tester is failing in all steps, i have checked the firewall, the firewall has been disabled.

can you provide any input on how to trouble shoot it.

Thanks in advance.

[YanMin]

Hi is there any further trouble shoot? For my checking, first 2 is green and last two is red. I have screenshot below. what should be the next step? Thanks in advance.

[Sonja_Bauernfeind]

Hello @YanMin 

The tester basically verifies if WebSockets can be established. If that is not the case, the next step would be to investigate with your IT infrastructure team. If you're looking for additional input from the Qlik Sense community, then I'd encourage you to post here: Deployment and Management.

[YanMin]

Hello @Sonja_Bauernfeind 

Yes, it is our internal IT problem. Sorry for the post. 

[Sonja_Bauernfeind]

We're always happy to help where we can, @YanMin! Never hesitate to reach out with questions in our community 🙂 

[BK-2021]

Hi, I keep getting "error uploading file" when trying to upload the html file?

[Sonja_Bauernfeind]

Hello @BK-2021 Are you able to upload different files? What error message are you seeing?

I've tested the instructions provided in this article (and updated them) and they do work. This may require a post on our community to help you troubleshoot, but let's hear what error you are getting first and if you can upload any other files.

All the best,
Sonja 

[BK-2021]

Thanks for the reply @Sonja_Bauernfeind  
It was the security rules I set wrongly. WebTest all seemed good, so there were no explanation for the constant timeout I get while created apps using the script editor (I have to reload all the time).

Kind regards,
Bjørn

[JimmiV]

Hi Team,

the tester passed all the steps but if I ran from VB.Net the code ILocation.GetAppIdentifiersAsync() I get an error opening the web socket. Stack trace below:

at Qlik.Sense.JsonRpc.RpcConnection.<RepeatAttempt>d__55.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable`1.ConfiguredTaskAwaiter.GetResult()
at Qlik.Sense.JsonRpc.RpcConnection.<OpenAsync>d__54.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable.ConfiguredTaskAwaiter.GetResult()
at Qlik.Sense.JsonRpc.RpcConnection.<EnsureConnectionIsOpen>d__67.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable.ConfiguredTaskAwaiter.GetResult()
at Qlik.Sense.JsonRpc.RpcConnection.<SendAsync>d__65.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable.ConfiguredTaskAwaiter.GetResult()
at Qlik.Engine.Communication.QlikConnection.<PingAsync>d__56.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable.ConfiguredTaskAwaiter.GetResult()
at Qlik.Sense.JsonRpc.GenericLocation.<DisposeOnErrorAsync>d__34.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable.ConfiguredTaskAwaiter.GetResult()
at Qlik.Engine.LocationExtensions.<HubAsync>d__23.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.ConfiguredTaskAwaitable`1.ConfiguredTaskAwaiter.GetResult()
at Qlik.Engine.LocationExtensions.<GetAppIdentifiersAsync>d__19.MoveNext()
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.TaskAwaiter`1.GetResult()
at Smouse.Qlik.SIEngine.VB$StateMachine_17_GetListaAppAsync.MoveNext()

[Sonja_Bauernfeind]

Hello @JimmiV 

I would recommend posting this in our forums with additional information on what you are attempting to achieve. This is likely the best forum choice: Qlik Sense Extensions and Integration.

All the best,
Sonja