Difference between revisions of "Configuring a SugarCRM Data Source using a CDATA JDBC Driver"

From Explore Analytics: The Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
  
Before you can add a SQLite data source, you must install the [[Explore Analytics Agent]]. Please see the section [[Installing the Explore Analytics Agent]] for installation instructions.
+
Before you can add a SugarCRM data source using a CDATA JDBC Driver, you must install the [[Explore Analytics Agent]]. Please see the section [[Installing the Explore Analytics Agent]] for installation instructions.
  
The agent should be installed on a Windows computer that has access to the database file, typically the computer where the file resides.
+
In addition to installing the agent, you need to obtain and install the CDATA SugarCRM JDBC Driver:
 +
* Obtain the SugarCRM JDBC driver from CDATA (you'll need to get a license for it from CDATA)
 +
* Install the SugarCRM JDBC driver following the CDATA instructions
 +
* copy the driver files over to the agent. You'll need to locate the driver's "lib" folder. This folder typically contains 3 files: cdata.jdbc.sugarcrm.jar, cdata.jdbc.sugarcrm.lic, and cdata.jdbc.sugarcrm.remoting.ini
 +
* copy the 3 files over to the Agent's "lib" folder. This is the folder containing ".jar" file including "agent.jar". On Windows, the folder name defaults to "c:\Program Files (x86)\Explore Analytics\Explore Analytics Agent\lib".
  
The rest of this page assumes that you have the agent installed and running. You're now ready to setup a SQLite data source and create live reports that draw data directly from your database.
+
The rest of this page assumes that you have the agent installed and running. You're now ready to setup a SugarCRM data source and create live reports that draw data directly from SugarCRM.
  
 
== Creating the Explore Analytics Data Source ==
 
== Creating the Explore Analytics Data Source ==
  
To create the data source, go to the "Data" menu and select the option "Add a new data source", then select "SQLite".
+
To create the data source, go to the "Data" menu and select the option "Add a new data source", then select "SugarCRM using CDATA".
  
 
You will see the following dialog (we show it with some example inputs already populated). We then explain each entry.
 
You will see the following dialog (we show it with some example inputs already populated). We then explain each entry.
  
[[File:add_sqlite_data_source.png]]
+
[[File:add_sugarcrm_data_source.png]]
  
 
=== Data Source Name ===
 
=== Data Source Name ===
Line 27: Line 31:
 
The choices for this field are typically pre-populated for you, and there's usually only one choice. This is the name of the Explore Analytics account through which the agent connects to Explore Analytics. You will need to make a selection here only if you have multiple agents that service different data sources.
 
The choices for this field are typically pre-populated for you, and there's usually only one choice. This is the name of the Explore Analytics account through which the agent connects to Explore Analytics. You will need to make a selection here only if you have multiple agents that service different data sources.
  
=== Database File Name (*.db) ===
+
=== SugarCRM URL ===
  
This is the name of the file (you can use forward or backwards slashes in the file name).
+
This is the URL of your SugarCRM instance that you log into.
 +
 
 +
=== SugarCRM User ===
 +
 
 +
The SugarCRM user Id that Explore Analytics will use for getting data from SugarCRM.
 +
 
 +
=== SugarCRM Password ===
 +
 
 +
The password for the SugarCRM user Id.
 +
 
 +
=== Time Zone ===
 +
 
 +
Dates returned by SugarCRM will be displayed in this timezone. Select the timezone that's appropriate for your organization.
  
 
== Getting Help ==
 
== Getting Help ==

Revision as of 12:55, 7 April 2018

Overview

Before you can add a SugarCRM data source using a CDATA JDBC Driver, you must install the Explore Analytics Agent. Please see the section Installing the Explore Analytics Agent for installation instructions.

In addition to installing the agent, you need to obtain and install the CDATA SugarCRM JDBC Driver:

  • Obtain the SugarCRM JDBC driver from CDATA (you'll need to get a license for it from CDATA)
  • Install the SugarCRM JDBC driver following the CDATA instructions
  • copy the driver files over to the agent. You'll need to locate the driver's "lib" folder. This folder typically contains 3 files: cdata.jdbc.sugarcrm.jar, cdata.jdbc.sugarcrm.lic, and cdata.jdbc.sugarcrm.remoting.ini
  • copy the 3 files over to the Agent's "lib" folder. This is the folder containing ".jar" file including "agent.jar". On Windows, the folder name defaults to "c:\Program Files (x86)\Explore Analytics\Explore Analytics Agent\lib".

The rest of this page assumes that you have the agent installed and running. You're now ready to setup a SugarCRM data source and create live reports that draw data directly from SugarCRM.

Creating the Explore Analytics Data Source

To create the data source, go to the "Data" menu and select the option "Add a new data source", then select "SugarCRM using CDATA".

You will see the following dialog (we show it with some example inputs already populated). We then explain each entry.

Add sugarcrm data source.png

Data Source Name

Give this data source a name to identify it.

Description

Optional description. This is shown when you list data sources to help users choose the correct data source.

Agent Service Account

The choices for this field are typically pre-populated for you, and there's usually only one choice. This is the name of the Explore Analytics account through which the agent connects to Explore Analytics. You will need to make a selection here only if you have multiple agents that service different data sources.

SugarCRM URL

This is the URL of your SugarCRM instance that you log into.

SugarCRM User

The SugarCRM user Id that Explore Analytics will use for getting data from SugarCRM.

SugarCRM Password

The password for the SugarCRM user Id.

Time Zone

Dates returned by SugarCRM will be displayed in this timezone. Select the timezone that's appropriate for your organization.

Getting Help

Setting up an agent-based data source is the most difficult task in Explore Analytics. Don't hesitate to seek help. You can contact Explore Analytics Support.