VOOZH about

URL: https://www.cdata.com/kb/tech/dataverse-sync-multiple-accounts.rst

⇱ Replicate Multiple Microsoft Dataverse Accounts via the CData Sync CLI

Replicate Multiple Microsoft Dataverse Accounts via the CData Sync CLI

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Replicate multiple Microsoft Dataverse accounts to one or many databases.

CData Sync for Microsoft Dataverse is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple Microsoft Dataverse connections. In this article we show how to use the CLI to replicate multiple Microsoft Dataverse accounts.

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


Configure Microsoft Dataverse Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple Microsoft Dataverse accounts, use multiple configuration files. Below is an example configuration to replicate Microsoft Dataverse to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
 <DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
 <ConnectionString>OrganizationUrl=https://myaccount.crm.dynamics.com/;InitiateOAuth=GETANDREFRESH;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
 <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime>
 <TaskSchedulerInterval>Never</TaskSchedulerInterval>
</CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
<DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider>
 <ConnectionString>OrganizationUrl=https://myaccount.crm.dynamics.com/;InitiateOAuth=GETANDREFRESH;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

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.

Configure Queries for Each Microsoft Dataverse Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Microsoft Dataverse API. The statement below caches and incrementally updates a table of Microsoft Dataverse data: 

REPLICATE Accounts;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Microsoft Dataverse accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement: 

REPLICATE PROD_Accounts SELECT * FROM Accounts

Alternatively, you can use a different schema: 

REPLICATE PROD.Accounts SELECT * FROM Accounts

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

CDSSync.exe -g MyProductionCDSConfig.xml -f MyProductionCDSSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar CDSSync.jar -g MyProductionCDSConfig.xml -f MyProductionCDSSync.sql