How to connect to Sugar CRM Data from IntelliJ

The CData JDBC Driver for Sugar CRM enables you to access Sugar CRM as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Sugar CRM data in IntelliJ.

Create a JBDC Data Source for Sugar CRM

Follow the steps below to add the driver JAR and define connection properties required to connect to Sugar CRM data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.sugarcrm.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.sugarcrm.SugarCRMDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:sugarcrm: and includes connection properties separated with semicolons.

     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.

     A typical JDBC URL is the following:

     jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;

Edit and Save Sugar CRM Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.