Model Context Protocol (MCP) finally gives AI models a way to access the business data needed to make them really useful at work. CData MCP Servers have the depth and performance to make sure AI has access to all of the answers.
Try them now for free →
Edit and Search Microsoft Dataverse External Objects in Salesforce Connect (API Server)
Use the API Server to securely provide OData feeds of Microsoft Dataverse data to smart devices and cloud-based applications. Use the API Server and Salesforce Connect to create Microsoft Dataverse objects that you can access from apps and the dashboard.
The CData API Server enables you to access Microsoft Dataverse data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce1 Mobile App. In this article, you will use the API Server and Salesforce Connect to access Microsoft Dataverse external objects alongside standard Salesforce objects.
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
Set Up the API Server
If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure Microsoft Dataverse OData services:
Connect to Microsoft Dataverse
To work with Microsoft Dataverse data from Salesforce Connect, we start by creating and configuring a Microsoft Dataverse connection. Follow the steps below to configure the API Server to connect to Microsoft Dataverse data:
- First, navigate to the Connections page.
-
Click Add Connection and then search for and select the Microsoft Dataverse connection.
-
Enter the necessary authentication properties to connect to Microsoft Dataverse.
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.
- After configuring the connection, click Save & Test to confirm a successful connection.
Configure API Server Users
Next, create a user to access your Microsoft Dataverse data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:
- On the Users page, click Add User to open the Add User dialog.
-
Next, set the Role, Username, and Privileges properties and then click Add User.
-
An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:
Creating API Endpoints for Microsoft Dataverse
Having created a user, you are ready to create API endpoints for the Microsoft Dataverse tables:
-
First, navigate to the API page and then click
Add Table
.
-
Select the connection you wish to access and click Next.
-
With the connection selected, create endpoints by selecting each table and then clicking Confirm.
Gather the OData Url
Having configured a connection to Microsoft Dataverse data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:
Connect to Microsoft Dataverse Data as an External Data Source
Follow the steps below to connect to the feed produced by the API Server.
- Log into Salesforce and click Setup -> Develop -> External Data Sources.
- Click New External Data Source.
- Enter values for the following properties:
- External Data Source: Enter a label to be used in list views and reports.
- Name: Enter a unique identifier.
- Type: Select the option "Salesforce Connect: OData 4.0".
URL: Enter the URL to the OData endpoint of the API Server. The format of the OData URL is https://your-server:your-port/api.rsc.
Note that plain-text is suitable for only testing; for production, use TLS.
- Select the Writable External Objects option.
Select JSON in the Format menu.
- In the Authentication section, set the following properties:
- Identity Type: If all members of your organization will use the same credentials to access the API Server, select "Named Principal". If the members of your organization will connect with their own credentials, select "Per User".
- Authentication Protocol: Select Password Authentication to use basic authentication.
- Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
- Username: Enter the username for a user known to the API Server.
- Password: Enter the user's authtoken.
Synchronize Microsoft Dataverse Objects
After you have created the external data source, follow the steps below to create Microsoft Dataverse external objects that reflect any changes in the data source. You will synchronize the definitions for the Microsoft Dataverse external objects with the definitions for Microsoft Dataverse tables.
- Click the link for the external data source you created.
- Click Validate and Sync.
- Select the Microsoft Dataverse tables you want to work with as external objects.
Access Microsoft Dataverse Data as Salesforce Objects
After adding Microsoft Dataverse data as an external data source and syncing Microsoft Dataverse tables with Microsoft Dataverse external objects, you can use the external objects just as you would standard Salesforce objects.
-
Create a new tab with a filter list view:
-
Display related lists of Microsoft Dataverse external objects alongside standard Salesforce objects:
-
Create, read, update, and delete Microsoft Dataverse objects from tabs on the Salesforce dashboard:
Troubleshooting
You can use the following checklist to avoid typical connection problems:
- Ensure that your server has a publicly accessible IP address. Related to this check, but one layer up, at the operating system layer, you will also need to ensure that your firewall has an opening for the port the API Server is running on. At the application layer, ensure that you have added trusted IP addresses on the Settings -> Security tab of the administration console.
- Ensure that you are using a connection secured by an SSL certificate from a commercial, trusted CA. Salesforce does not currently accept self-signed certificates or internal CAs.
Ensure that the server you are hosting the API Server on is using TLS 1.1 or above. If you are using the .NET API Server, you can accomplish this by using the .NET API Server's embedded server.
If you are using IIS, TLS 1.1 and 1.2 are supported but not enabled by default. To enable these protocols, refer to the how-to on MSDN and the Microsoft technical reference.
If you are using the Java edition, note that TLS 1.2 is enabled by default in Java 8 but not in Java 6 or 7. If you are using these earlier versions, you can refer to this this Oracle how-to.
