MuleSoft Connector for Dataverse

Build 21.0.7930

Establishing a Connection

This section describes how to connect to Dataverse from your AnyPoint Studio project. You can use wizards or the XML editor in AnyPoint Studio to define connection properties in a global element. Global elements can be reused across other building blocks in your project.

Create a Connection in the Visual Editor

Complete the following steps to visually add the connector to your project and create a connection:

  1. Create a new Mule Project in Anypoint Studio.
  2. From the palette, drag the connector into your Mule flow.
  3. On the Message Flow canvas, double-click the connector icon to open the connector properties in the Properties pane.
  4. In the General section, click Add and define the Dataverse connection properties. Note that the user name and Password properties always appear here. The user name must be set as it is used as the key for the connection if connection pooling is enabled.

Create a Connection in the XML Editor

Set connection properties in the <cdata-cds:config> element in the root of the project's XML.

Note: The user name attribute must always be included here and serves as the key for the connection if connection pooling is enabled.

  <cdata-cds:config name="CData_CDS_Configuration" username="MyName" connectionProperty1="MyProperty" ... doc:name="CData CDS: Configuration"/> 

Schema

Dataverse supports schema values of 'System' and 'Entities' and can be set using the Schema property.

Using 'System' for Schema property uses the Web API to query entities/tables.

Using 'Entities' for Schema property uses the EntityDefinitions entity set path and retrieves information about EntityMetadata EntityType entities/tables. This will often result in more user friendly names, though requires extra metadata requests.

Connecting to Dataverse

To authenticate to the Dataverse source, you should first set the OrganizationUrl to the URL of the organization you are connecting to, such as https://[organization].crm.dynamics.com.

Authenticating using Azure AD

Azure AD is a connection type that goes through OAuth. Set your AuthScheme to AzureAD and see Using OAuth Authentication for an authentication guide.

Authenticating using Azure Service Principal

Azure Service Principal is a connection type that goes through OAuth. Set your AuthScheme to AzureServicePrincipal and see Using Azure Service Principal Authentication for an authentication guide.

Authenticating using MSI Authentication

If you are running Dataverse on an Azure VM, you can leverage Managed Service Identity (MSI) credentials to connect:

  • AuthScheme: Set this to AzureMSI.

The MSI credentials will then be automatically obtained for authentication.

Configure Connector Operations

The connector is an operation-based connector; its operations correspond to SQL statements and expose other functionality such as Schema Discovery. See Using the Connector (Mule 3.8+) for more information on executing SQL to Dataverse in Mule applications.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930