Welcome Guest, you are in: Login

QVSource: The QlikView & Qlik Sense API Connector (Docs)

IMPORTANT:
  • We only officially support running QVSource in this way (i.e. as a Windows Service) on Windows Server editions (e.g. Windows Server 2008, Windows Server 2012) - desktop operating systems such as Windows 7 ands 8 are not officially supported - you should simply manually run QVSource after you have logged into Windows.

  • Running QVSource in this way is enabled through the QVSource licence file you are provided with (the trial/evaluation licence will allow this work). Without such a licence although the following instructions will still work when you attempt to load data into QlikView or any other application you will receive a licence error.

  • This page is valid for both the WinForms and Web Editions of QVSource (although the path the the QVSource.exe might difffer slightly).



Before You Start

Before you start the following steps to get QVSource running as a service, you should check the following
  • you are using a licence that has Server Edition = true. You can find this on the licence tab in QVSource.
    • if you are using a trial of QVSource this should be enabled
    • if you have purchased QVSource, you need to use the Server Edition licences - these tend to have the file name enterpriseserver1@abc.lic or smallbusinessserver1@abc.lic
  • if necessary, you have 'unblocked' your QVSource download (zip file) as explained here

Installing the Service

You should see in your QVSource installation directory a file structure similar to the following.

Note that before you continue, if this is the first time you are running QVSource from this location, you must first run QVSource.exe (the desktop client of QVSource) and accept the EULA terms. Otherwise you will not be able to start the QVSource service.

You should also at this point install your licence file.

You should see in your QVSource installation directory a file named QVSourceService.exe as highlighted below:

Image

You should also have a folder named Batch Files:

Image

Containing a file named Install Service:

Image

You should open this file in your favourite text editor (e.g. Notepad) and find something like the following:

Image

If necessary, you should now edit the two paths underlined below to point to the correct locations on your machine:

Image

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 done this you can save and close the file, then double click it to run it (note you should run it as an Administrator). You should see something like this:

Image

Indicating success. If you do not see this please check the troubleshooting section below.

You should now find if you view the local services on your machine you have a new entry for QVSource:

Image

If you bring up the properties dialog for the service, you can start it by pressing the button shown below:

PLEASE NOTE: It is important that QVSource is not running when you do this (for example, if you have been launching QVSource.exe manually on your desktop, make sure that this is closed. A quick check for this is to look for instances of QVSource.exe in your process explorer.

Image

You should also set the service to restart automatically if it fails:

Image

(Above, we have also set it to restart immediately rather than the default of after one minute).

Finally, you may wish to change the account which the service is running under.

Image

Changing The User Account

This page has instructions on how to set up the Windows Service to run under a standard user account although in most cases it should be OK to use the standard account setup when configuring the services.

PLEASE NOTE: Whichever account you do use, you should ensure that it has access to the directory where QVSource is installed as well as the cache directory.

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.

Finally, if you are using a Firewall you may well need to ensure that this service user account has permission to access the external internet.

Checking QVSource Is Running

Once you have carried out the above steps, you should be able to browse to http://localhost:5555/QVSource and see a status screen similar to the following:

Image

Here you should check:
  • That the server mode is true.
  • That the licence expiry 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.

Checking the Event Log

The QVSource Windows Service will log information regarding it's start up to two places.

The first is a text file named Service_Startup_Log.txt alongside the QVSourceService.exe executable file.

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

Image

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.

First locate the Uninstall Service batch file:

Image

Edit the same two paths as noted in the installation section above:

Image

Then save, close and run the batch file by double clicking it (note you should run it as an Administrator). You should see something like the following:

Image

Upgrading QVSource

  • When upgrading QVSource, go to the Services window and stop the service.
  • Then, follow these instructions.
  • Once those steps are followed you should be able to simply restart the service.

Troubleshooting

Issues Installing The Service

If you get the following error:

Running a transacted installation.
 
Beginning the Install phase of the installation.
See the contents of the log file for the c:\QVSource\QVSourceService.exe assembly's progress.
The file is located at c:\QVSource\QVSourceService.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:\QVSource\QVSourceService.exe assembly's progress.
The file is located at c:\QVSource\QVSourceService.InstallLog.
 
The Rollback phase completed successfully.
 
The transacted install has completed.

Or the following error:

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 QVSource files which you downloaded from the internet.

The steps to unblock the files are explained on this page. 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:

Image

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

Other Issues

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

It might be because you are running behind a firewall and QVSource 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 QVSource service is running under has permissions to connect to the external internet.


(QVSource works with Qlik Sense as well as QlikView - See this page for notes.)
QVSource - The QlikView & Qlik Sense API Connector | © Copyright 2011 - 2016 Industrial CodeBox Ltd