Welcome Guest, you are in: Login

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

SugarCRM Connector For QlikView & Qlik Sense

RSS
Modified on 2016/10/25 11:26 by chrisb Categorized as connector
The SugarCRM Connector for QlikView and Qlik Sense is available in QVSource version 1.5.2 and later.


Usage

The Connector allows QlikView and Qlik Sense users to load the following tables:

  • Accounts
  • Contacts
  • Leads
  • Opportunities
  • Forecasts
  • Meetings
  • Calls
  • Tasks
  • Products
  • Reports
  • Notes
  • CustomModule (allows you to specify any module)
  • CustomRequest (allows you to get related records for a given object - version 0.8.4 of Connector and later)

The following is a screen shot of the connector:

Image

NOTE that the latest version also allows ordering and max number of items input parameters to be specified for further refining the result set and increasing load times.

Base URL

You will need to enter your SugarCRM 'base url' in order to use the connector, this should just be the instance url for your SugarCRM - in other words the URL you usually browse to if you want to login to SugarCRM as usual.

To test this, you can append '/rest/v10/help' on to see if you get the API docs. So for example, if your usual URL is:
http://mycomanyssugar.com

Try browsing to:
http://mycomanyssugar.com/rest/v10/help

And if you get the API docs come up then your base url is 'http://mycomanyssugar.com'.

Retrieving Related Records

You can use the CustomModule table to retrieve related records. For example, if you have an account with ID bc432277-348c-85db-e7d0-5491ab72b2b1, entering:
Accounts/bc432277-348c-85db-e7d0-5491ab72b2b1/link/contacts

Should retrieve a list of contacts for that account. Note that you would probably then need to construct a QlikView or Qlik Sense load script to loop through all the IDs and request their related records assuming that you wanted all of them in your data model.

NOTE: Version 0.8.4 of the connector has a 'CustomRequest' table which is the recommended method for achieving this, the steps are identical to above).

CustomRequest and Filters

You can specify filters and additional parameters when using the CustomRequest table.

For example, you could enter the following to retrieve all contacts entered before 1st jan 2015 and only retrieve the id and name fields.
Contacts?filter[0][date_entered][$lt]=2015-01-01&fields=id,name

You can find some more information on filters here.

Embedding Credentials In Request

Note that you can also embed the following parameters in your QVSource request:

  • baseUrl
  • userName
  • passwordEncrypted (You can retrieve this from the Encrypt table of the Helper Connector).

If you wish to override the settings stored in the QVSource Connector config.

Troubleshooting

Slow Response Times

One user has reported that if the account used with the connector is NOT an administrator then the API requests will receive a lower priority from SugarCRM and will run more slowly. In the example which was reported requests run using an Admin account retrieving all contacts were about 10x faster than with a non admin account.

Change Log

1.0.4 - 31/07/2015
  • Updated authorisation checks to reauthenticate and retry once in the case of a 401 error on a request.

1.0.3 - 22/05/2015
  • Added CustomRequestAsXml table.
  • Improved code for checking refreshing access token.

1.0.2 - 16/03/2015
  • Added max results and order by inputs.

1.0.1 - 20/02/2015
  • API requests should now be logged to log (if turned on in QVSource).
  • Minor code refactoring.
  • Connector now filters out duplicates (based on id) - Meetings table was noted to return duplicated in tests.

1.0.0 - 16/02/2015
  • Taken out of beta.

0.8.5 - 09/02/2015
  • Added new Tasks, Products, Reports and Notes tables.
  • Fixed progress reporting.

0.8.4 - 17/12/2014
  • Added CustomRequest table (initially added to allow related records to be retrieved).

0.8.3 - 07/08/2014
  • Added CustomModule table.

0.8.2 - 12/02/2014
  • Added Calls table.

0.8.0 - 30/01/2014
  • Initial version.
  Name Size
- SugarCRM Connector For QlikView.png 185.02 KB


(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