Connect Sugar CRM to IBM WebSphere Using the CData JDBC Driver

IBM WebSphere is a powerful application server that runs many enterprise level Java applications and services. When paired with the CData JDBC Driver for Sugar, IBM WebSphere applications can connect to Sugar CRM and work with data using standard SQL queries instead of complex APIs. This simplifies integration, reduces development effort, and provides secure, real-time access to critical business data.

Prerequisites

1. Access to a Sugar CRM account (with API permissions)
2. IBM WebSphere Application Server (configured and running)
3. CData JDBC Driver for Sugar
4. Java Servlet WAR application ready for deployment

Note: This article uses Salesforce as a demonstration data source, but the same steps can be followed to connect to any of the 250+ JDBC Drivers available in our portfolio.

Getting Started

Step 1: Download and install the CData JDBC Driver for Sugar

Download and install the CData JDBC Driver for Sugar, which provides a .jar file: cdata.jdbc.sugarcrm.jar

Step 2: Install and configure IBM Websphere

1. Create an account in IBM WebSphere using the official IBM site.
2. Install and configure the IBM Websphere Application server in the local system using the documentation: IBM Websphere Application Server
3. Once the application server is installed, start the WebSphere Server using the Admin Console in your browser: https://your-server:9043/ibm/console
👁 Login to Websphere admin console

Step 3: Set up the JDBC provider and data source for Sugar CRM

1. Go to Resources, expand the JDBC section, and then select JDBC providers to create a new provider
👁 Create new JDBC providers

2. Select the appropriate scope from the drop down menu
👁 Select the scopes

3. Click New to add a JDBC provider
• Choose User defined as the database type
• Enter cdata.jdbc.sugarcrm.SugarCRMConnectionPoolDataSource as the implementation class name
• Type a name for the provider, for example User defined JDBC Provider
• Enter the full path of the JDBC driver JAR file in the classpath field
• Click Next, then Finish, and save the changes to the master configuration.
👁 Creating JDBC Provider

4. Once the JDBC provider is created, add a JDBC data source.
• Enter the basic details such as Data Source Name and JNDI name
• Select the existing JDBC provider created earlier (e.g., CData Sugar CRM Provider)
• Provide the Implementation class name: cdata.jdbc.sugarcrm.SugarCRMConnectionPoolDataSource
• Add the Data Store Helper Class Name: com.ibm.websphere.rsadapter.GenericDataStoreHelper
• Configure security by setting authentication aliases if required
• Review the Summary page to verify all details and click Finish to complete the data source creation
👁 Adding JDBC data source

5. Select the newly created data source from the list and open Custom properties
6. Add the JDBC connection string under the URL property and press OK. For example:

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

   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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   Note: If the URL property is not available, create it and then add the JDBC connection string.

   Tip: Always test the connection string with the driver before entering it in the URL property. 👁 Adding JDBC data source
   
7. Now open the data source and choose Test Connection
👁 Testing the connection

Step 4: Build the web application

1. Build the web application using preferred Java framework (Servlet, JSP, or Spring). The resulting .war file will typically follow a structure like this:

		Sugar CRMServletApp.war
		|--webcontent
		| |--index.jsp -- JSP page (entry point)
		| |
		| |--WEB-INF/ --Hidden from direct browser access
		| |--web.xml -- Deployment descriptor
		| |
		| |--classes/ --Compiled .class files
		| |--com/example/Sugar CRM/
		| |--Sugar CRMServlet.class
		|
		|--lib/ --Dependency JARs
		|--cdata.jdbc.sugarcrm.jar
	

2. Define the data access logic using JDBC or JPA, referencing the data source through a JNDI name
3. This article explains how to set up a JDBC connection and deploy a Java Servlet application
4. Package the project as a WAR (Web Application Archive) or EAR (Enterprise Archive) file for deployment
• In a terminal compile the java file using the command:

  			cd webcontent
  			jar cvf ..\Sugar CRMServletApp.war *
  		

Step 5: Deploy the Sugar CRM application in WebSphere

1. In the WebSphere admin console, go to Applications and select Install New Application
2. Browse and upload the WAR file, then continue with the installation wizard.

Step 6: Retrieve Sugar CRM data through WebSphere

1. Access the application using its context root: http://hostname:port/context-root/page
👁 Demo application
Note: Ensure the deployed application is started before opening it in the browser. 👁 Data is retrieved

We can now view the retrieved data from the source. The data is accessible directly through IBM WebSphere. This setup demonstrates how a servlet can be deployed in WebSphere to retrieve Sugar CRM data using the JDBC driver, creating a strong foundation for building advanced Sugar CRM powered enterprise applications.

Get Started with Connecting Sugar CRM to IBM WebSphere

Start connecting Sugar CRM to IBM WebSphere with the CData JDBC Connector today. Download the free 30-day trial and explore how easy it is to enable secure, real-time data access for your applications. As always, our world-class Support Team is available to help with any questions you may have.