Virtual Entity – New way of integration Part 1

We have seen this question many times in Dynamics CRM forums, “How can I show my custom db data into CRM forms with saving it into Dynamics CRM” and the possible options are to develop a custom control using scripting for example HTML or host a custom report/web page on iframe if you are working with CRM version <9. But now in Dynamics 365 we can use Virtual entity to show our data from different sources. In this article we are going to discuss about Virtual Entities. Virtual Entities are special type of entity which does not have any SQL table associated in backend to store it’s data under Dynamics 365/CRM database instead they get their data from different source with the help of data provider. Mainly virtual entity are consist of three components: virtual1
Data Provider is responsible for bringing data from external data sources, we can use build our own custom data provider or can use OData data provider which is included in Dynamics 365. You can get more details from here to create custom data provider . Data Source is a record in Dynamics 365 which stores details about data provider and required connection parameters. Finally entity definition stores structure of virtual entity just like other entities. It also stores information about which data source is used for this virtual entity.

We can create virtual entity just like other custom entities by navigating to Settings-> Customization-> Customize the System or we can also create our own custom solution and create virtual entity there. While creating virtual entity we need to select Virtual Entity checkbox and need to configure below 4 points:

We are using a test service from as a data source, you can refer details steps here to use test service from External Name is the name of the object that we want to show over virtual entity and external collection name is the name of object collection, for example employee is the object and employees is the name of collection here. While creating virtual entity, you need to make sure external name and external collection name should match to entity type name and entityset name exactly.
Virtual entity is created with just two out of the box fields primary id and primary field. But we can add custom fields and relationship as required. While adding other custom field keep in mind their data type should be exactly mapped to the data type of the external object’s properties. Apart from these, external object must have a unique key (GUID) which can be mapped to the primary id of virtual entity.

In next article we are going to demonstrate how to write our own OData Wep API for virtual entity, so stay tuned !!

2 thoughts on “Virtual Entity – New way of integration Part 1

  1. Pingback: Virtual Entity – New way of integration Part 2 | HIMBAP

  2. Pingback: Interessante Dynamics CRM Blog Posts KW 47 - Martins Dynamics CRM/365 Blog

Leave a Reply

Your email address will not be published. Required fields are marked *