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 

[henrikalmen]

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?

[Rakesh_HB]

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.

[Sonja_Bauernfeind]

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 

[shimazaki]

@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

[Sonja_Bauernfeind]

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 

[shimazaki]

@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.

[Sonja_Bauernfeind]

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 

[shimazaki]

@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.

[Sonja_Bauernfeind]

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 

[shimazaki]

@Sonja_Bauernfeind 

Thank you for your response.

I understand.

Thank you for your frequent responses.