1404 Wednesday, June 1, 2016 |
Suresh Maurya
Dynamics CRM Consultant at IBM

Understanding Entity Change Tracking in Microsoft Dynamics CRM

In CRM integration projects, your business requirements often dictate that you should only retrieve those transaction records that have been recently created or modified in your source system since last integration. When your CRM system is the source, you would typically use CRM FetchXML query to pull data from the CRM system by comparing the record's modifiedon field, which is not a solution that is reliable enough and may not perform well when the source entity has a significant number of records.

To address this particular challenge, CRM Online 2015 Update 1 release introduced the Change Tracking feature, which offers a reliable and efficient way to track transactional data changes for CRM entities.

Turn on Change Tracking

In order to track data changes of a particular entity, you have to first turn on "Change Tracking" option for the entity. You would do so by going to the entity's customization page, and tick "Change Tracking" option under "Data Services" section.

Retrieve Changes

After Change Tracking has been enabled for the entity, you can use CRM SDK RetrieveEntityChangesRequest message to pull changes from CRM server. The following is a snippet that demonstrates how to pull changes from the CRM server.

 using (var service = new OrganizationService(crmConnection))
{
var request = new RetrieveEntityChangesRequest();

// Set which entity to get changes for.
request.EntityName = "account";
request.Columns = new ColumnSet("accountnumber", "name", "creditlimit");

// Set paging preferences.
request.PageInfo = new PagingInfo() { Count = 5000, PageNumber = 1 };

// Set change token returned from last pull.
request.DataVersion = changeToken; // set to null or remove this line to do an initial pull

// Get the changes.
var response = (RetrieveEntityChangesResponse)service.Execute(request);

// TODO: Process all the changed records (see the code snippet below)

// Save the token somewhere for future use
changeToken = response.EntityChanges.DataToken;
Console.WriteLine(changeToken);
}

Walk through Changes

After retrieving the changes, you will get two types of results. The first type of result is the newly added or updated records, and the second one is for the records that have been deleted since the last pull.

// Replace the TODO line in the above snippet with the following code
foreach (var change in response.EntityChanges.Changes)
{
if (change.Type == ChangeType.NewOrUpdated)
{
var changedItem = (NewOrUpdatedItem)change;
Entity newOrChangedEntity = changedItem.NewOrUpdatedEntity;
// TODO: Process new or updated entity record
}
else if (change.Type == ChangeType.RemoveOrDeleted)
{
var deleteditem = (RemovedOrDeletedItem)change;
EntityReference deletedEntityReference = deleteditem.RemovedItem;
// TODO: Process deleted entity records
}
}

Note that the returned NewOrChangedEntity is an instance of Entity class, while the RemovedItem (the deleted record) is an instance of EntityReference class.

Some Closing Notes

There are a few things that you should be aware when using this feature:

  • The "Change Tracking" option is an entity-level setting. It has to be enabled for the entity before you can use RetrieveEntityChangesRequest to pull data. If the option is not enabled, and you try to use this feature, you will get an error message telling you "Entity: account isn't enabled for change tracking" where account can be any entity name that you are working with.
  • Due to the fact that the "Change Tracking" option works at entity level, you would need to keep track of the change token for each entity individually. There is no organization level tracking token.
  • There is one special situation that you should watch out for. Suppose there is a newly added record after last pull and it was deleted before the new pull, you will get the record in the Delete result set, which you may not have knowledge about it.
  • In the case that you have selected to return a lookup field, the field's Name property is not returned.
  • When change collection has more records than the page size that you have specified, you would have to page through the change collection.
  • Based on my preliminary testing, it appears that CRM keeps multiple token versions, which is really nice. However, I imagine keeping too many versions on the server side would not make sense as each version would consume a certain amount of database space. There must be a limit in terms of how many versions are kept on the CRM server side. It could be either a time-based limit (say 90 days probably, which could still be a lot of change versions if I keep pulling from the server every 30 seconds) or a number-based limit. This is something that has yet to be confirmed.
  • When you retrieve changes using this feature, you will get the records in their current status, the old values before the change are not returned.
  • The user account needs to have organization level read (or so-called "Root Read") privileges for the concerned entity in order to uses RetrieveEntityChangesRequest to retrieve changes.
  • More details about this feature can be found at the CRM SDK documentation page: Use change tracking to synchronize data with external systems.

What meant by ribbon definitions?

Is the root tag which defined in entity ribbon xml under this can see UI tags, templates, command definitions and rule definitions?

Associate Records in Dynamics CRM - Late Bound

Following example demonstrates how to associate contact to account in dynamics crm using late bound

public static void AssociateRecord(EntityReference contact, EntityReference account, IOrganizationService service)
{
// Creating EntityReferenceCollection for the Contact
EntityReferenceCollection relatedEntities = new EntityReferenceCollection();

// Add the related entity contact
relatedEntities.Add(contact);

// Add the Account Contact relationship schema name
Relationship relationship = new Relationship("contact_customer_accounts");

// Associate the contact record to Account
service.Associate(account.LogicalName, account.Id, relationship, relatedEntities);
}

Images in Microsoft Dynamics CRM

MS CRM Notes


Images in Microsoft Dynamics CRM

Images in Dynamics CRM are snapshot of record in SQL server, before and after the core system operation.

Pre-Image

Pre-Image, returns the image of the record as is stored in the SQL database before the CRM Platform action has been performed.

Post-Image

Post-Image, returns the image of the record as is stored in the SQL database after the CRM Platform action has been performed.

Message Stage Pre-Image Post-Image
Create PRE No No
Create POST No Yes
Update PRE Yes No
Update POST Yes Yes
Delete PRE Yes No
Delete POST Yes No

Example Usage:

  • Comparison of record before and after the operation to build custom audit functionality.
  • In update operation get value of attributes in plugin which are not changed.
  • To improve performance by avoiding retrieve query to Dynamics CRM.

Msxrmtools.com

Installation and Configuration for Microsoft Dynamics Marketing Connector for Microsoft Dynamics CRM

Update Process Enhancements with Microsoft Dynamics CRM Online 2015 Update

Lead Management: Disqualifying Lead

To Disqualify a Lead click Disqualify.

The user must select a reason why the lead is being disqualified

Folder Level Tracking in CRM Online 2015 Update 1

Tracking email activities is key to successful customer engagement, from sales to service. In this video, we'll walk you through setting up folder level tracking to simplify and automate email tracking, which improves end-user productivity and helps to drive positive customer engagement. For more information, visit http://www.microsoft.com/en-us/dynamics/crm-customer-center/default.aspx and http://go.microsoft.com/fwlink/?LinkId=394323

Ad-hoc Reporting for Microsoft Dynamics AX, NAV, GP, SL and CRM

In this video, you will learn how easy it is to query and report on your Microsoft Dynamics AX, NAV, GP, SL and CRM ERP database with BI360's ad-hoc reporting tool.
 

 

CRM 2013 Quick Tip: Quickly access customer data in Microsoft Dynamics CRM

CRM 2011 Excel Export & Import

This video shows a new feature in CRM 2011 that allows you to export data from CRM, edit it, and import it back into CRM. This is a great way to make changes to a lot of records at one time. It's also a great way to mess up a lot of records at one time, so take care.

Color Grid for Dynamics 365

Color Form for Dynamics 365