article Qlik Sense WebSocket Connectivity Tester in Official Support Articles

Qlik Sense WebSocket Connectivity Tester

Lisa_Sun — Thu, 10 Apr 2025 12:00:55 GMT

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:

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.

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

Locate

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

Change it to

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

Restart the proxy
Run the WebSocket Connectivity tester
Revert the change

How to use the Websocket Connectivity Tester

Download the attached package or download the package from GitHub: https://github.com/flautrup/QlikSenseWebsocketConnectivityTester
Unzip the file
Login to the Qlik Sense Management Console
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
Click Contents in the Associated items menu
Click Upload
Upload the QlikSenseWebsocketTest.html file.
Copy the correct URL from the URL path
Open a web browser (from any machine from which you wish to test the WebSocket connection).
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.

Re: Qlik Sense Websocket Connectivity Tester

primecoder — Wed, 11 Nov 2020 03:26:02 GMT

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.

Re: Qlik Sense Websocket Connectivity Tester

YanMin — Wed, 05 May 2021 03:52:33 GMT

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.

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Wed, 05 May 2021 07:03:29 GMT

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.

Re: Qlik Sense Websocket Connectivity Tester

YanMin — Wed, 05 May 2021 07:08:54 GMT

Hello @Sonja_Bauernfeind

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

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Wed, 05 May 2021 07:27:58 GMT

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

Re: Qlik Sense Websocket Connectivity Tester

BK-2021 — Fri, 10 Dec 2021 10:39:49 GMT

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

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Fri, 10 Dec 2021 13:38:45 GMT

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

Re: Qlik Sense Websocket Connectivity Tester

BK-2021 — Tue, 14 Dec 2021 12:02:13 GMT

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

Re: Qlik Sense Websocket Connectivity Tester

JimmiV — Thu, 14 Apr 2022 17:04:27 GMT

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()

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Tue, 19 Apr 2022 06:22:20 GMT

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

Re: Qlik Sense Websocket Connectivity Tester

henrikalmen — Wed, 21 Dec 2022 14:15:10 GMT

Is this test still working with Qlik Sense Enterprise November 2022? I'm asking since the first two tests are successful, but the last two tests fail for me. I get "Failed to get productVersion [object Object] using WSS" and "Failed to get application list [object Object] using WSS". Any ideas on what I should do to resolve those?

Re: Qlik Sense Websocket Connectivity Tester

Rakesh_HB — Thu, 29 Dec 2022 18:00:12 GMT

Hello @henrikalmen ,

Yes, we did a test with Qlik Sense November 2022 Patch 3 and it ran successfully.

Please make sure to follow the suggestions mentioned in the article if it fails.

Also, for your information, in the earlier posts here (Check Page 1), found to be an internal IT problem.

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Wed, 25 Oct 2023 06:17:56 GMT

Hello @shimazaki

Verify that WebSocket is enabled in the network infrastructure, such as firewalls, browsers, reverse proxies, etc. Speak to your network administrator for details.

All the best,
Sonja

Re: Qlik Sense Websocket Connectivity Tester

shimazaki — Wed, 25 Oct 2023 07:18:14 GMT

@Sonja_Bauernfeind

Thank you for your reply.
I will check with our network administrator.

This time, when accessing the HUB you are getting the following error when trying to open an application in the Qlik Sense Hub
"Unable to connect to the Qlik Sense engine. Possible causes: too many connections, the service is offline, or networking issues."

We then investigated

・Maximum number of connections
・Allow WebSocket traffic

with reference to the following postings.

The maximum number of connections was fine and the WebSocket traffic results were as I posted earlier.

Is there anything else I can investigate and address regarding the original error other than what you posted below?

Unable to connect to the Qlik Sense engine error d... - Qlik Community - 1717211

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Wed, 25 Oct 2023 07:20:41 GMT

Hello,

The Qlik Sense hub will not function if your network does not allow connectivity through WebSockets. Even if another issue may be concealed by the Websocket problem, you will need to resolve this first.

All the best,
Sonja

Re: Qlik Sense Websocket Connectivity Tester

shimazaki — Tue, 31 Oct 2023 23:54:14 GMT

@Sonja_Bauernfeind

I am sorry that I have not contacted you since then.

What is the result of each of the following responses that you have confirmed?
Also, what should we check for items that have failed?
・Authentication (Success)
・Connect secure websocket (Success)
・Product version collected through secure websocket (Failure)
・Application list through secure websocket (Failure)
・Connect websocket (success)

・Product version collected through websocket (Success)

・Connect websocket (Success)

・Product version collected through websocket (Success)

・Application list through websocket (Success)

＞Even if another issue may be concealed by the Websocket problem, you will need to resolve this first.
What should this be checked for?

Thank you in advance for your help.

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Wed, 01 Nov 2023 09:16:27 GMT

Hello, @shimazaki You will need to work with your network team to investigate what is being blocked or if any at all, and review the Qlik Sense log files for any possible errors.

For additional information on troubleshooting Qlik Sense Hub or QMC issues, see Qlik Sense - How to troubleshoot issue to access QMC and HUB. For general information on where to find log files, see Log Folder.

If you need more direct assistance, please post about your issue in the Qlik Sense Deployment and Management forum. Include the symptoms, versions, error message (gathered from screenshots and log files), and information on whether or not this has ever worked previously or if this is a new setup.

All the best,
Sonja

Re: Qlik Sense Websocket Connectivity Tester

shimazaki — Tue, 07 Nov 2023 01:16:51 GMT

@Sonja_Bauernfeind

Thank you for your response.

By the way, could you please tell us what each test item is verifying?

I apologize for repeating myself, but thank you in advance.

Re: Qlik Sense Websocket Connectivity Tester

Sonja_Bauernfeind — Tue, 07 Nov 2023 07:25:18 GMT

Hello @shimazaki

Authentication verifies if you can authenticate. Connect secure WebSocket verifies if you can establish a secure connection. Product version verifies that it can collect the product version. Application list verifies if it can obtain the app list. General connect WebSocket verifies if the WebSocket connection can be established.

I recommend you focus on reviewing the log files and troubleshooting steps above and posting about the issue in our deployment forum. Unfortunately, we cannot assist you with troubleshooting a complex issue in an article.

All the best,
Sonja