How to Build an ETL App for Salesforce CRM Analytics Data in Python with CData Connect AI

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Connect AI Python SDK and the petl framework, you can build Salesforce CRM Analytics-connected applications and pipelines for extracting, transforming, and loading Salesforce CRM Analytics data. This article shows how to connect to Connect AI and use petl to extract, transform, and load Salesforce CRM Analytics data.

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so petl can read directly from the SDK connection with etl.fromdb. There is no driver to install per source: connect with a Personal Access Token and build your pipeline.

Connect to Salesforce CRM Analytics in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "Salesforce CRM Analytics" from the Add Connection panel

3. Enter the necessary authentication properties to connect to Salesforce CRM Analytics.

   Salesforce CRM Analytics uses the OAuth 2 authentication standard. Obtain the OAuthClientId and OAuthClientSecret by registering an app with Salesforce CRM Analytics.

   See the Getting Started section of the Help documentation for an authentication guide.

   Multi-Factor Authentication (MFA)

   If the connected Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies alongside the standard OAuth flow.

   
4. Click Save & Test
5. Navigate to the Permissions tab and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK and the petl framework using the pip utility:

pip install cdata-connect-ai
pip install petl

Build an ETL App for Salesforce CRM Analytics Data in Python

Once the required modules are installed, you are ready to build the ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, import the modules and connect to Connect AI with your account email and PAT:

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Create a SQL Statement to Query Salesforce CRM Analytics

Use SQL to create a statement for querying Salesforce CRM Analytics. In this article, we read data from the Dataset_Opportunity entity. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, SalesforceCRMAnalytics1).

sql = (
    "SELECT Name, CloseDate "
    "FROM [SalesforceCRMAnalytics1].[SalesforceCRMAnalytics].[Dataset_Opportunity] "
    "WHERE StageName = 'Closed Won'"
)

Extract, Transform, and Load the Salesforce CRM Analytics Data

With a connection and query in hand, use petl to extract, transform, and load the Salesforce CRM Analytics data. In this example, we extract Salesforce CRM Analytics data, sort the data by the CloseDate column, and load the data into a CSV file.

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'CloseDate')

etl.tocsv(table2, 'dataset_opportunity_data.csv')

Load New Rows Back into Salesforce CRM Analytics

When Salesforce CRM Analytics supports writes, load rows back with a batch INSERT. The SDK's executemany takes @name placeholders and a list of parameter dictionaries, one per row.

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [SalesforceCRMAnalytics1].[SalesforceCRMAnalytics].[Dataset_Opportunity] (Name, CloseDate) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

Note: Even for writable sources, a read-only PAT or connection permission will reject write operations.

With the CData Connect AI Python SDK, you can work with Salesforce CRM Analytics data just like you would with any database, including direct access to data in ETL packages like petl.

More Information and Free Trial

Now you can pipe live Salesforce CRM Analytics data through petl using the CData Connect AI Python SDK. For more information on connecting to Salesforce CRM Analytics (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start building data pipelines for live Salesforce CRM Analytics data in Python.

Full Source Code

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT Name, CloseDate "
    "FROM [SalesforceCRMAnalytics1].[SalesforceCRMAnalytics].[Dataset_Opportunity] "
    "WHERE StageName = 'Closed Won'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'CloseDate')

etl.tocsv(table2, 'dataset_opportunity_data.csv')

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [SalesforceCRMAnalytics1].[SalesforceCRMAnalytics].[Dataset_Opportunity] (Name, CloseDate) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()