VOOZH about

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

⇱ Connect to Microsoft Dataverse Data in CloverDX (formerly CloverETL)

Connect to Microsoft Dataverse Data in CloverDX (formerly CloverETL)

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Transfer Microsoft Dataverse data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Microsoft Dataverse enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Microsoft Dataverse as sources and destinations. In this article, you will use the JDBC Driver for Microsoft Dataverse to set up a simple transfer into a flat file. The CData JDBC Driver for Microsoft Dataverse enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Microsoft Dataverse as sources and destinations. In this article, you will use the JDBC Driver for Microsoft Dataverse to set up a simple transfer into a flat file.

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


Connect to Microsoft Dataverse as a JDBC Data Source

  1. Create the connection to Microsoft Dataverse data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.cds.jar file.
  3. Enter the JDBC URL.

    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.

    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.

    👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    A typical JDBC URL is below:

    jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/;InitiateOAuth=GETANDREFRESH;
👁 Required connection properties specified in the JDBC URL. (Salesforce is shown.)

Query Microsoft Dataverse Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Microsoft Dataverse JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: 
    SELECT AccountId, Name FROM Accounts WHERE Name = 'MyAccount'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Accounts table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.
👁 A simple transfer to a flat file.