Ready to get started?

Learn more about the CData JDBC Driver for Sugar or download a free trial:

Download Now

Bridge Sugar CRM Connectivity with Apache NiFi

Access and process Sugar CRM data in Apache NiFi using the CData JDBC Driver.

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for Sugar CRM, NiFi can work with live Sugar CRM data. This article describes how to connect to and query Sugar CRM data from an Apache NiFi Flow.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Sugar CRM data. When you issue complex SQL queries to Sugar CRM, the driver pushes supported SQL operations, like filters and aggregations, directly to Sugar CRM and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Sugar CRM data using native data types.

Connecting to Sugar CRM Data in Apache NiFi

  1. Download the CData JDBC Driver for Sugar CRM installer, unzip the package, and run the JAR file to install the driver.
  2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.sugarcrm.jar (and cdata.jdbc.sugarcrm.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

    On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for Sugar CRM.

  3. Start Apache NiFi. For example:

    cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
    run-nifi.bat
    
  4. Navigate to the Apache NiFi UI in your web browser: typically http://localhost:8080/nifi
  5. Click the (Configuration) button from the Operate sidebar.
  6. In the NiFi Flow Configuration page, navigate to the Controller Services tab.
  7. Click the button to create a new controller service.
  8. In the Add Controller Service page, select DBCPConnection Pool, and then click Add.
  9. Click the gear button to configure the new DBCPConnection Pool.
  10. In the Configure Controller Service page, navigate to the Properties tab. Fill in the properties:

    PropertyValue
    Database Connection URLjdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;
    Database Driver Class Namecdata.jdbc.sugarcrm.SugarCRMDriver

    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.

    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.

  11. Click the button to enable the new DBCPConnection Pool.

Your Sugar CRM data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor.

Download a free, 30-day trial of the CData JDBC Driver for Sugar CRM and start working with your live Sugar CRM data in Apache NiFi. Reach out to our Support Team if you have any questions.