How to integrate Sugar CRM with Apache Airflow

Apache Airflow supports the creation, scheduling, and monitoring of data engineering workflows. When paired with the CData JDBC Driver for Sugar, Airflow can work with live Sugar CRM data. This article describes how to connect to and query Sugar CRM data from an Apache Airflow instance and store the results in a CSV file.

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.

Configuring the Connection to Sugar CRM

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.

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.

To host the JDBC driver in clustered environments or in the cloud, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

The following are essential properties needed for our JDBC connection.

Establishing a JDBC Connection within Airflow

1. Log into your Apache Airflow instance.
2. On the navbar of your Airflow instance, hover over Admin and then click Connections.
3. Next, click the + sign on the following screen to create a new connection.
4. In the Add Connection form, fill out the required connection properties:
   • Connection Id: Name the connection, i.e.: sugarcrm_jdbc
   • Connection Type: JDBC Connection
   • Connection URL: The JDBC connection URL from above, i.e.: jdbc:sugarcrm:RTK=5246...;User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;)
   • Driver Class: cdata.jdbc.sugarcrm.SugarCRMDriver
   • Driver Path: PATH/TO/cdata.jdbc.sugarcrm.jar
5. Test your new connection by clicking the Test button at the bottom of the form.
6. After saving the new connection, on a new screen, you should see a green banner saying that a new row was added to the list of connections:

Creating a DAG

A DAG in Airflow is an entity that stores the processes for a workflow and can be triggered to run this workflow. Our workflow is to simply run a SQL query against Sugar CRM data and store the results in a CSV file.

1. To get started, in the Home directory, there should be an "airflow" folder. Within there, we can create a new directory and title it "dags". In here, we store Python files that convert into Airflow DAGs shown on the UI.
2. Next, create a new Python file and title it sugar crm_hook.py. Insert the following code inside of this new file:

   	import time
   	from datetime import datetime
   	from airflow.decorators import dag, task
   	from airflow.providers.jdbc.hooks.jdbc import JdbcHook
   	import pandas as pd
   
   	# Declare Dag
   	@dag(dag_id="sugar crm_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv'])
   	
   	# Define Dag Function
   	def extract_and_load():
   	# Define tasks
   		@task()
   		def jdbc_extract():
   			try:
   				hook = JdbcHook(jdbc_conn_id="jdbc")
   				sql = """ select * from Account """
   				df = hook.get_pandas_df(sql)
   				df.to_csv("/{some_file_path}/{name_of_csv}.csv",header=False, index=False, quoting=1)
   				# print(df.head())
   				print(df)
   				tbl_dict = df.to_dict('dict')
   				return tbl_dict
   			except Exception as e:
   				print("Data extract error: " + str(e))
               
   		jdbc_extract()
       
   	sf_extract_and_load = extract_and_load()
   

3. Save this file and refresh your Airflow instance. Within the list of DAGs, you should see a new DAG titled "sugar crm_hook".
4. Click on this DAG and, on the new screen, click on the unpause switch to make it turn blue, and then click the trigger (i.e. play) button to run the DAG. This executes the SQL query in our sugar crm_hook.py file and export the results as a CSV to whichever file path we designated in our code.
5. After triggering our new DAG, we check the Downloads folder (or wherever you chose within your Python script), and see that the CSV file has been created - in this case, account.csv.
6. Open the CSV file to see that your Sugar CRM data is now available for use in CSV format thanks to Apache Airflow.

More Information & Free Trial