VOOZH about

URL: https://www.cdata.com/kb/tech/dataverse-jdbc-hulft-integrate.rst

⇱ Connect to Microsoft Dataverse Data in HULFT Integrate

Connect to Microsoft Dataverse Data in HULFT Integrate

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Microsoft Dataverse as a JDBC data source in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Microsoft Dataverse, HULFT Integrate can work with live Microsoft Dataverse data. This article explains how to connect to Microsoft Dataverse and move the data into a CSV file.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Microsoft Dataverse data. When you 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 allows you to work with and analyze Microsoft Dataverse data using native data types.

About Microsoft Dataverse Data Integration

CData provides the easiest way to access and integrate live data from Microsoft Dataverse (formerly the Common Data Service). Customers use CData connectivity to:

  • Access both Dataverse Entities and Dataverse system tables to work with exactly the data they need.
  • Authenticate securely with Microsoft Dataverse in a variety of ways, including Azure Active Directory, Azure Managed Service Identity credentials, and Azure Service Principal using either a client secret or a certificate.
  • Use SQL stored procedures to manage Microsoft Dataverse entities - listing, creating, and removing associations between entities.

CData customers use our Dataverse connectivity solutions for a variety of reasons, whether they're looking to replicate their data into a data warehouse (alongside other data sources)or analyze live Dataverse data from their preferred data tools inside the Microsoft ecosystem (Power BI, Excel, etc.) or with external tools (Tableau, Looker, etc.).


Getting Started


Enable Access to Microsoft Dataverse

To enable access to Microsoft Dataverse data from HULFT Integrate projects:

  1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.cds.jar (and cdata.jdbc.cds.lic), to the jdbc_adapter subfolder for the Integrate Server
  2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Microsoft Dataverse Data

Once you copy the JAR files, you can create a project with access to Microsoft Dataverse data. Start by opening Integrate Studio and creating a new project.

  1. Name the project
  2. Ensure the "Create script" checkbox is checked
  3. Click Next 👁 Creating a new project.
  4. Name the script (e.g.: CDStoCSV)

Once you create the project, add components to the script to copy Microsoft Dataverse data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

  1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Microsoft Dataverse. Set the following properties:
    • Name: Microsoft Dataverse Connection Settings
    • Driver class name: cdata.jdbc.cds.CDSDriver
    • URL: jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/;InitiateOAuth=GETANDREFRESH;

      👁 JDBC connection settings (Salesforce is shown).

      Built-in Connection String Designer

      For assistance 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.)
  2. Write your SQL statement. For example: 
    SELECT AccountId, Name FROM Accounts
  3. Click "Extraction test" to ensure the connection and query are configured properly
  4. Click "Execute SQL statement and set output schema"
  5. Click "Finish" 👁 Configuring the Execute Select SQL operation

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

  1. Set a file to write the query results to (e.g. Accounts.csv)
  2. Set "Input data" to the "Select SQL" component
  3. Add columns for each field selected in the SQL query
  4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
  5. Click "Finish"

Map Microsoft Dataverse Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Microsoft Dataverse data into a CSV file.

👁 A completed script.

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