1279 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.

Update a Parent from a Child Record with a Dynamics CRM 2011 Workflow

Rather than make your users open multiple forms to update information, you can use Dynamics CRM 2011 workflows to update information on parent records from a child form. Here's how to do it.

Partner Landscape Overview: Microsoft Dynamics CRM 2011

A 30 second overview of the partner opportunities with Microsoft Dynamics CRM.

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

Customization Toolkit Overview - Microsoft Dynamics CRM 2011

This video is an overview of how to customize Dynamics CRM 2011. The video goes through a design scenario that demonstrates how to configure the forms, fields, views, charts and dashboards.

What is meant by solution and how and where it maintained in CRM?

A Solution is a container for components that make up a particular customization project. By keeping track of all the components of a single Solution, package, and maintain units of software that extend Microsoft Dynamics CRM

  1. When a Solution is exported or imported, all components are transferred.
  2. Version control is maintained
  3. Security specific to the Solution is applied to the correct entities.

Top 10 User Productivity Tips - Microsoft Dynamics CRM 2011

In this video are 10 productivity tips for CRM 2011 End Users:

  1. Set Your Personal Options
  2. Use Your Charts
  3. Use Your Filters
  4. * Search (improve search)
  5. Bulk Edit
  6. "Type and Tab"
  7.  Recently Visited "Records and Views"
  8. Use Your "Up and Down" Arrows
  9. Email Templates from CRM in Outlook
  10. "Email a Link"

coding

innocent 

Lead Management: Qualifying Leads Outcome

To Qualify a lead click Qualify.

Qualifying a lead can result in an Account, Contact, and/or Opportunity record being created.

The following values on the lead form control the outcome of the qualification process:

  • Existing Contact: If this existing contact value is populated and the company and existing account values are not, then the opportunity that is created is associated directly with the existing contact.
  • Title: This becomes the title of the opportunity that is created.
  • Name: If the name is populated, and the existing contact is not, this becomes the full name of the new contact. Additionally, if the existing contact value is empty and the company field is populated, this contact is associated with the new account. However, the opportunity is still associated with the account.
  • Company: If the existing account is blank, this becomes the name of the newly created account.

Microsoft Dynamics CRM 2011 - Strategy for Lowering CoGs

CRM 2013 Quick Tip: Add new information quickly through shortcuts in Microsoft Dynamics CRM