Welcome Guest, you are in: Login

QVSource - The QlikView API Connector (Docs)


Quick Start Guide

The following instructions will help you quickly get started with QVSource. Below are more detailed instructions should you need them.

This page might also be useful, especially for larger Enterprise users.

Installing QVSource

  • Having signed up and received your 'QVSource Download' email from us, please use the links to download QVSource and your licence file.
  • Create a folder on your root drive called 'QVSource' and Unzip the QVSource file's contents to this folder.
  • Double click QVSource.exe to launch QVSource.
  • In the QVSource application, go to the Licence tab and click 'Install Licence', browsing to the QVSource licence file you just saved.
  • When prompted enter the name you registered with.
  • QVSource is now licensed.
  • Note that if you are using the processParams[Sync|Async|Batch|Auto] parameter (explained here) in any of your load scripts you will need to ensure that QlikView AND QVSource have access to a folder where QlikView can store intermediate CSV parameter files and QVSource can read them (typically c:\Source\Temp). This is explained fully on this page.

The Connectors

  • QVSource will display all the connectors.
  • To configure a connector double click it.
  • Depending on the connector you may need to authenticate and provide other information on the first panel.
    • For example to use Google Analytics, you'll need to authenticate with an account that has access to a Google Analytics.
  • Each connector has it's own page on this wiki to help you further.

Getting Data and Using with QlikView

  • Once relevant details have been entered for a connector, you can then click on the 'Connector Data' tab.
  • This lists all the tables available for the connector.
  • Click on a table and QVSource will now request the data and populate a table with the results.
  • You can then go to the 'QlikView Load Script' tab and use the 'click here' link to copy the QlikView script that will perform the same operation from within QlikView.
  • Paste this script into a QlikView application.
  • Ensure QVSource is still running and from the QlikView application reload it.
  • You will now have data to work with.

Prerequisites

  • QVSource (you can request a download here).

  • QVSource should run on any Windows PC which has the .NET framework 4 (full edition) installed, please note however that we only support Windows 7 or later and Windows Server 2008 and later and we only offer support for the QVSource service on Windows Server editions.

NOTE - .NET 4.0 and .NET 3.5 will run side by side as stated by Microsoft.

  • QVSource should currently work with any version of QlikView. However we strongly recommend using QlikView 10 or later which has the new QVX data format. If you are using QlikView 9 or earlier you will need to use either the html or TSV data format provided by QVSource.

  • Note that for most of the connectors available so far, QVSource needs to connect to the internet in order to download data from whichever API you are interested in - therefore if you have a personal or corporate firewall preventing this it will not work - we do have some features which might help you configure this.

Installing & Running QVSource

NOTE: These instructions are for running QVSource in 'desktop' mode which is the recommended mode when you start using the product for the first time. If you would like to see the instructions on running QVSource in the background on a server (so that it is always up and available) see here.

QVSource is delivered as a zipped folder.

To allow for easy upgrading, we suggest taking the following approach.
  • Read this page regarding unblocking the downloaded files contained in the zip, particularly if you have followed these instructions once and are experiencing issues.
  • In a root drive, create a folder called 'QVSource'
  • Unzip the QVSource folder that your downloaded
  • Copy the contents of the unzipped folder to your new QVSource folder

You should now have a folder structure that looks something like this:

Image

  • You can now run the QVSource.exe file.

Note also that if you are using the processParams[Sync|Async|Batch|Auto] parameter in any of your load scripts you will need to ensure that QlikView AND QVSource have access to a folder where QlikView can store intermediate CSV parameter files and QVSource can read them (typically c:\QVSource\Temp). This is explained fully on this page.

If you experience any issues running QVSource we would recommend ensuring that you are running it as an administrator - this is done on Windows 7 and other Windows versions by right clicking on the executable and selecting the option highlighted below.

Image

The main QVSource window lists the connectors currently available.

Image

PLEASE NOTE : This exe should be run from your local hard drive - if you run the program from a shared network drive or mapped folder you might experience issues.

QVSource runs as a small webserver, by default on port 5555. If you minimise the window shown above you will see this indicated by the balloon tip and icon in the status bar.

Image

This port can be easily changed as explained here. In most cases this should not be necessary, if you do alter this be sure to restart QVSource.

Installing the Licence File

You should have received either a trial or commercial licence file - if you downloaded it from a web page, then it would have shown you a 'name to use'. You should go to the 'Licence' tab in QVSource and click the 'Install Licence' button then browse to your licence (.lic) file:

Image

QVSource will prompt you for the name you used when registering or purchasing QVSource:

Image

Checking Your Licence

You should check the details of your licence after installation, in particular:
  • The top red highlighted section below shows that QVSource is enabled to run in server mode - This is the part that says "Server Edition: True". If you have only purchased QVSource desktop edition this will not be present.
  • The additional part "Remote Access Enabled" means that QVSource does not need to be installed on the same machine as QlikView Server. This is a special feature not yet commercially supported. This may not be present in your licence.
  • The bottom highlighted area shows which connectors are licensed.

Image

You should also check the expiry date.

How the Licensing Works

Currently, any connectors which are still in beta (i.e. have a version number less than 1) are free to use. For connectors with a version number greater than 1 you will either need a commercial licence file which unlocks the connector or a trial licence file (which typically unlocks all of the connectors for a limited time period).

Note that without a licence file or with an expired licence file you should still be able to run the QVSource desktop application and interact with the connectors through the UI, however you will be unable to load data into your QlikView applications.

Checking you have the latest version

To check you are running the latest version of QVSource, go to the 'About' tab and click the following button:

Image

Using a specific connector

Selecting a Connector

Select a connector you wish to use and either double click the entry or click the 'Configure' button to bring up its configuration form. In this example we use the Google spreadsheets connector.

Image

Note that each connector should have a link to an associated help page at the bottom right:

Image

Connector Specific Configuration

Each connector will have a section of UI specific to that connector which captures any authentication or other information needed to connect to the API.

Image

Common Connector Configuration

As well as a section of UI common to all connectors.

Image

Change Log

Each connector should also have a change log where you can see changes made over each version. We would recommend you read this each time you upgrade QVSource.

Image

Using the connector

Most connectors will require you to enter at least some information, for example in this connector we enter our username and password, then click the 'Connect' button and select one of the spreadsheets we have access to.

Image

Once you have entered any required details into the 'Connector Specific Settings' tab, move to the 'Connector Data' tab. You should see a list of available tables for this API or data source. Selecting a table should download the data and show it in a datagrid.

Note that downloading large amounts of data from web APIs can be slow - this is usually a physical limitation of network speed rather than a QVSource issue. Some connectors make use of caching so subsequent requests are much faster but this varies from API to API and Connector to Connector.

Image

Copying and Pasting the QlikView Load Script

To load this table into QlikView, move to the 'QlikView Load Script' tab. Here you can edit the column prefix used and whether to use column headers for field names. Connectors should be designed so that in most cases the defaults are fine.

Image

You can click the link 'Click here' above the script to copy the script to your clipboard before pasting it directly into your QlikView load script.

Image

You should now be able to load the data directly into your QlikView application (don't forget to leave QVSource running).

Note that in this example the connector is using the credentials configured in QVSource. This means that if the QlikView application is run on another machine the same credentials (or a set which has access to the same spreadsheet) will also need to be set up otherwise the reload will fail. You also have the option of embedding the credentials in the load script as outlined here. This has the additional advantage that a single load script can connect to multiple different accounts. This feature is present in most connectors which require authentication.

Monitoring Updates and Changes

We update the wiki regularly and every connector page has a detailed change log (see one example here) and there is also a change log for the QVSource 'core'.

We would recommend using the wiki as a tool to stay up to date and receive automatic notifications of these changes as explained here.

We also post regular updates on Twitter and on also on our Facebook and Google+ pages.

Upgrading

Upgrading QVSource is easy, but by following some simple steps you'll be able to continue using the data that you've already you pulled down through the connectors, which is cached, as well as continue using your existing connector settings.

IMPORTANT: Please note however that you should read the change logs for QVSource as well as any connectors you are using. In particular because, very occasionally due to API changes out of our control, we have to introduce breaking changes which might effect your QlikView applications. Therefore it is important to check the change logs for any items which might apply yo you and update your QlikView applications and test where necessary.

  • Stop running QVSource.
  • Take a back up of your QVSource folder, which you created (see here) by zipping it up and keeping it somewhere safe.
  • On downloading the latest version of QVSource, you will have received a zip file - unzip this file somewhere. Note you might need to unblock this file.
  • Copy and paste its contents into the QVSource folder.
  • When prompted overwrite all files and folders. NOTE - It has been seen very occasionally that when you unzip QVSource (or any zip for that matter) to your machine the files/folders sometimes do not pick up or inherit the correct users/permissions which might result in a WinIOError when you try to run QVSource. You should check that your user account and/or whichever user account you have configured to run QVSource still has full access to this folder.
  • Your cached data in the \QVSource\Data folder should still be there (note: unless you have changed the cache location). If it's not, go to your backed up zip file and copy it's Data folder's contents into your 'live' Data folder.
  • Start QVSource again.

Advanced Usage

QVSource has some enterprise features which help users further secure their QVSource installation.

Advanced users may also wish to check through some of the wiki pages classified as advanced for more tips and advice on getting the most out of QVSource.

Support

If you have any trouble using QVSource please first ensure you have carefully read the above page and also followed the advice here.

If you are still experiencing issues we recommend submitting a support request either directly from the connector giving the issue, using the link highlighted below which is available on every connector (in the example below we use the Google Analytics connector).

Image

Or if it is a general usage issue, from the main form:

Image

If you are not able to even launch QVSource then you can navigate to the support system here.
© Copyright 2011 - 2014 Industrial CodeBox Ltd