Manage Sugar CRM Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Sugar CRM seamlessly integrates Sugar CRM data into database management tools like DBArtisan by enabling you to access Sugar CRM data as a database. This article shows how to create a JDBC source for Sugar CRM in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Sugar CRM Data into DBArtisan Projects

Follow the steps below to register Sugar CRM data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

   You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

   Additionally, specify the URL to the SugarCRM account.

   Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Sugar CRM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.sugarcrm.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   Below is a typical connection string:

   jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;
6. Finish the wizard to connect to Sugar CRM data. Sugar CRM entities are displayed in the Datasource Explorer.

You can now work with Sugar CRM data as you work with any other database. See the driver help documentation for more information on the queries supported by the Sugar CRM API.