Integrate Microsoft Dataverse with External Services using SnapLogic

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including Microsoft Dataverse, in their SnapLogic workflows.

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

Getting Started

---

Connect to Microsoft Dataverse in SnapLogic

To connect to Microsoft Dataverse data in SnapLogic, download and install the CData Microsoft Dataverse JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for Microsoft Dataverse/lib by default).

Upload the Microsoft Dataverse JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

👁 Uploaded JDBC Driver (Salesforce & QuickBooks Online are shown)

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to Microsoft Dataverse.

1. Navigate to the Designer tab
2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer 👁 Adding a Generic JDBC snap onto the designer
   
3. Click Add Account (or select an existing one) and click "Continue"
4. In the next form, configure the JDBC connection properties:
   • Under JDBC JARs, add the JAR file we previously uploaded
   • Set JDBC Driver Class to cdata.jdbc.cds.CDSDriver

   • Set JDBC URL to a JDBC connection string for the Microsoft Dataverse JDBC Driver, for example:

     jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/;InitiateOAuth=GETANDREFRESH;RTK=XXXXXX;

     NOTE: RTK is a trial or full key. Contact our Support team for more information. 👁 Configuring a connection (Salesforce is shown)
     

     Built-In Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Microsoft Dataverse JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.cds.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

     • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
     • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
     • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

     When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     
5. After entering the connection properties, click "Validate" and "Apply"

Read Microsoft Dataverse Data

In the form that opens after validating and applying the connection, configure your query.

• Set Schema name to "CDS"
• Set Table name to a table for Microsoft Dataverse using the schema name, for example: "CDS"."Accounts" (use the drop-down to see the full list of available tables)
• Add Output fields for each item you wish to work with from the table

👁 Configuring a Select snap (Salesforce is shown)

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

👁 Click the end of the snap to preview the data.

Once you confirm the results are what you expect, you can add additional snaps to funnel your Microsoft Dataverse data to another endpoint.

👁 Previewing data (Salesforce is shown).

Piping Microsoft Dataverse Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
2. Add an account to connect to Google Sheets 👁 Connecting to Google
   
3. Configure the Worksheet Writer snap to write your Microsoft Dataverse data to a Google Spreadsheet 👁 Writing to a Google Spreadsheet
   

You can now execute the fully configured pipeline to extract data from Microsoft Dataverse and push it into a Google Spreadsheet.

👁 Data written to Google Spreadsheets (Salesforce is shown)

Piping External Data to Microsoft Dataverse

As mentioned above, you can also use the JDBC Driver for Microsoft Dataverse in SnapLogic to write data to Microsoft Dataverse. Start by adding a Generic JDBC - Insert or Generic JDBC - Update snap to the dashboard.

1. Select the existing "Account" (connection) or create a new one
2. Configure the query:
   • Set Schema name to "CDS"
   • Set Table name to a table for Microsoft Dataverse using the schema name, for example: "CDS"."Accounts" (use the drop-down to see the full list of available tables)
   👁 Configuring a INSERT snap (Salesforce is shown)
   
3. Save the Generic JDBC - Insert/Update snap

At this point, you have configured a snap to write data to Microsoft Dataverse, inserting new records or updating existing ones.

More Information & Free Trial

Using the CData JDBC Driver for Microsoft Dataverse you can create a pipeline in SnapLogic for integrating Microsoft Dataverse data with external services. For more information about connecting to Microsoft Dataverse, check at our CData JDBC Driver for Microsoft Dataverse page. Download a free, 30 day trial of the CData JDBC Driver for Microsoft Dataverse and get started today.