Qlik Community

Ask a Question

Knowledge

Search or browse our knowledge base to find answers to your questions ranging from account questions to troubleshooting error messages. The content is curated and updated by our global Support team

Announcements
Talk to Experts Tuesday: Live chat Aug. 24th 10 AM ET: Bring your Qlik Gold Client questions REGISTER TODAY

Setting up the Qlik Web Connectors to run as a Service

Bjorn_Wedbratt
Support
Support

Setting up the Qlik Web Connectors to run as a Service

 

This procedure can also be found under Setting up Qlik Web Connectors to run as a Windows service.

For steps on how to simply run the Web Connector process in the user space, see How To Install and Apply Qlik Web Connector License . 

 

Installing the Qlik Web Connector Service

Steps:


1. After extracting the zip-file, in the Qlik Web Connectors installation directory there should be a file structure similar to the following:

000020387a.png

 


2. Before continuing:
If this is the first time running Qlik Web Connectors from this location, first run QlikWebConnectors.exe (the desktop client of Qlik Web Connectors) and accept the EULA terms, as it would be done with a Basic Qlik Web Connector installation if running Qlik Web Connector as a service was not a requirement. Otherwise it will not be possible to start the Qlik Web Connectors service. Once run at least once, close the QlikWebConnector desktop application or the service will fail to start later on the last step as well.

You should also at this point have registered Qlik Web Connectors

 

3. Locate the file 'Install Service.bat' in the folder [INSTALL_DIR]\BatchFiles

4. Open 'Install Service.bat' in a text editor (eg. Notepad) 

5. Make sure the path to QlikWebConnectorsSVC.exe reflects your installation path. In this example Qlik Web Connectors has been installed in E:\QlikWebConnectors\


000020387b.png

  

Note: You should ensure you use the 32 bit path here, e.g. C:\Windows\Microsoft.NET\Framework\v4.0.30319\installutil not C:\Windows\Microsoft.NET\Framework64\v4.0.30319\installutil.
 
Once you have made the changes you can save and close the file.

 

6.  Right-click 'Install Service.bat' and select "Run as administrator"

000020387c.png

  

  • A message "The Commit phase completed successfully" will indicate a successful installation of the service. If you do not see this please check the troubleshooting section below.

7. Open Services in Windows and you should find a new entry for Qlik Web Connectors:

 000020387e.png

 

 

8. Right-click the Qlik Web Connectors service and select Properties

  • On the Log On tab, define the account to be used for Qlik Web Connectors, or select Local System account
Note: Whichever account you do use, you should ensure that it has access to the directory where Qlik Web Connectors is installed as well as the cache directory, see Qlik Web Connectors - Clearing Cached Data 
For the batching and asynchronous features the account should also have access to the location(s) where you are writing CSV tables from your QlikView load script.
000020387f.png

 

 

9. (optional) Go to the Recovery tab and set First failure to Restart the Service. This will make sure the service automatically restarts in case of failure.

10. Press OK and select Start the service in Windows services to start Qlik Web Connectors as a service

 

11. Confirm that QVSource Is Running

Once the service is installed and started, you should be able to browse to http://localhost:5555/qvsource  and see a status screen similar to the following:

000020387g.png

 

12. Here you should check:

 

  • That the Server Mode is true.
  • That the License Expires date is in the future and as expected.
  • That there is a list of Connectors shown.
  • That you are running the latest (or at least expected) version.


If you do not see this screen please refer to the event log and troubleshooting sections below.
 

Troubleshooting:

Checking the Event Log

The Qlik Web Connectors service will log information regarding it's start up in two places.

The first is Service_Startup_Log.txt found in your installation folder for Qlik Web Connectors

The second is the Windows Application Event Log as shown below.

000020387h.jpg

 

Note: If your service is not starting as expected you should consult these sources for an indication of what might be wrong.

 

Uninstalling the Service

This is very similar to the first steps of installing the service.

  1. Locate the file 'Uninstall Service.bat' in the folder [INSTALL_DIR]\BatchFiles
  2. Open 'Uninstall Service.bat' in a text editor (eg. Notepad) 
  3. Make sure the path to QlikWebConnectorsSVC.exe reflects your installation path. In this example Qlik Web Connectors has been installed in E:\QlikWebConnectors\
  4. 000020387i.pngOnce you have made the changes you can save and close the file.
  5. Right-click 'Uninstall Service.bat' and select "Run as administrator"000020387j.png
  6. The message "The uninstall has completed" will indicate a successful removal of the service. 

 

Issues Installing / Uninstalling the service

If you get the following error:
 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Running a transacted installation.
  
Beginning the Install phase of the installation.
See the contents of the log file for the c:\QlikWebConnectors\QlikWebConnectors.exe assembly's progress.
The file is located at c:\QlikWebConnectors\QlikWebConnectors.InstallLog.
  
An exception occurred during the Install phase.
System.Security.SecurityException: The source was not found, but some or all event logs could not be searched.  Inaccessible logs: Security.
  
The Rollback phase of the installation is beginning.
See the contents of the log file for the c:\QlikWebConnectors\QlikWebConnectors.exe assembly's progress.
The file is located at c:\QlikWebConnectors\QlikWebConnectors.InstallLog.
  
The Rollback phase completed successfully.
  
The transacted install has completed.


Or the following error:

1
2
3
Exception occurred while initializing the installation:
 
System.IO.FileLoadException: Could not load file or assembly "file:///{YOUR_PATH_HERE}" or one of its dependencies. Operation is not support. (Exception from HRESULT: 0×80131515).


when attempting to install the service it might be because you need to 'unblock' the Qlik Web Connectors files which you downloaded.

The steps to unblock the files are explained in Unblocking the Qlik Web Connectors zip distribution . Please read this page carefully as you might need to involve your system administrator.
 

Issues Running The Service

If you get an error when attempting to start the service, e.g. something like this:

000020387k.png

 

Please check the windows event log and Service_Startup_Log.txt file (as discussed above) for indications of the reason.

 

Also see Issues starting Qlik Web Connectors Web Service  

 

Other Issues

If you see the following error in your Qlik Web Connectors event logs or response from Qlik Web Connectors: System.Net.WebException: The remote name could not be resolved

It might be because you are running behind a firewall and Qlik Web Connectors is not able to make a connection to the outside world. One method of fixing this might be to ensure that the user account which the Qlik Web Connectors service is running under has permissions to connect to the external internet.

Related Content:

Labels (2)
Version history
Revision #:
2 of 2
Last update:
‎2021-05-19 10:30 AM
Updated by:
 
Contributors