It is available as NuGet package: http://nuget.org/packages/EnterpriseLibrary.Logging.DynamicsCrm2011

The project site is: http://entlibmscrmlog.codeplex.com/

After installing the NuGet package, there will be a folder added to visual studio project which includes two *.zip file. One is the un-managed Dynamics CRM solution and the other is managed Dynamics CRM solution. These two solutions are the sample except one being managed and the other is not. The solution contains one single entity where all the log information and message are saved.

After import the solution into Dynamics CRM organisation, you need to create a connection string in your web.config/app.config file.

The following is a sample configuration for On Premise Integrated Windows Authentication

<pre><?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <connectionStrings>
    <add name="Crm" connectionString="Url=https://domain.com/orgname;"/>
  </connectionStrings>
</configuration></pre>

More samples please see project site or http://msdn.microsoft.com/en-us/library/gg695810.aspx

After than you can configure enterprise library logging using the configuration file either manually or using enterprise library configuration tool. It also support configuration through fluent API.

The complete sample code using Rhino Mocks can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Rhino Mocks

Unit test CRM plugin is straightforward as well, it is just a bit tedious. IPlugin.Execute only accept one parameter which is IServiceProvider. Through IServiceProvider we can retrieve at least 3 interface and we need to set up 5 interface, which will be IOrganizationService, IPluginExecutionContext, ITracingService, IOrganizationServiceFactory and IServiceProvider.

Suppose we have a sample Dynamics CRM plugin, which is called after a contact is created within Dynamics CRM, if the parent customer is set to an account, the number of employees attribute of that account will be increased by one.

Code Under Test

public class Plugin : IPlugin
 {
 private string _unsecure, _secure;

/// <summary>
 /// Alias of the image registered for the snapshot of the
 /// primary entity's attributes after the core platform operation executes.
 /// The image contains the following attributes:
 /// parentcustomerid
 ///
 /// Note: Only synchronous post-event and asynchronous registered plug-ins
 /// have PostEntityImages populated.
 /// </summary>
 private readonly string postImageAlias = "PostCreateImage";

public Plugin(string unsecure, string secure)
 {
 _unsecure = unsecure;
 _secure = secure;
 }

public void Execute(IServiceProvider serviceProvider)
 {
 // Obtain the execution context service from the service provider.
 var pluginExecutionContext = (IPluginExecutionContext)serviceProvider.GetService(typeof(IPluginExecutionContext));

if (pluginExecutionContext.Stage == 40 && pluginExecutionContext.MessageName == "Create" && pluginExecutionContext.PrimaryEntityName == "contact")
 {
 // Obtain the tracing service from the service provider.
 var tracingService = (ITracingService)serviceProvider.GetService(typeof(ITracingService));

// Obtain the Organization Service factory service from the service provider
 IOrganizationServiceFactory factory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));

// Use the factory to generate the Organization Service.
 var organizationService = factory.CreateOrganizationService(pluginExecutionContext.UserId);

Entity postImageEntity = (pluginExecutionContext.PostEntityImages != null && pluginExecutionContext.PostEntityImages.Contains(this.postImageAlias)) ? pluginExecutionContext.PostEntityImages[this.postImageAlias] : null;

// when a contact is created with parent account, increase number of employees for that account
 if (postImageEntity != null && postImageEntity.Contains("parentcustomerid"))
 {
 EntityReference parentCustomer = postImageEntity.GetAttributeValue<EntityReference>("parentcustomerid");

if (parentCustomer != null && parentCustomer.LogicalName.ToLowerInvariant() == "account")
 {
 tracingService.Trace("Parent account id: {0}.", parentCustomer.Id);

Entity parentAccount = organizationService.Retrieve("account", parentCustomer.Id, new Microsoft.Xrm.Sdk.Query.ColumnSet("numberofemployees"));

int numberOfEmployees = 0;
 if (parentAccount.Contains("numberofemployees"))
 {
 numberOfEmployees = parentAccount.GetAttributeValue<int>("numberofemployees");
 }

parentAccount["numberofemployees"] = numberOfEmployees + 1;

organizationService.Update(parentAccount);
 }
 }
 }
 }
 }

Unit Test

[TestMethod()]
 public void ExecuteTest()
 {
 //
 // Arrange
 //
 string unsecure = "unsecure";
 string secure = "secure";
 Plugin target = new Plugin(unsecure, secure);

var accountId = Guid.NewGuid();
 var previousNumber = 3;
 var expected = 4;
 var actual = 0;

// IOrganizationService
 var service = MockRepository.GenerateStub<IOrganizationService>();
 service.Stub(x => x.Retrieve(null, Guid.Empty, null)).IgnoreArguments().Return(
 new Microsoft.Xrm.Sdk.Entity("account")
 {
 Id = accountId,
 Attributes = { { "numberofemployees", previousNumber } }
 });

service.Stub(x => x.Update(null)).IgnoreArguments().Do((Action<Entity>)delegate(Entity entity)
 {
 actual = entity.GetAttributeValue<int>("numberofemployees");
 });

// IPluginExecutionContext
 var pluginExecutionContext = MockRepository.GenerateStub<IPluginExecutionContext>();
 pluginExecutionContext.Stub(x => x.Stage).Return(40);
 pluginExecutionContext.Stub(x => x.MessageName).Return("Create");
 pluginExecutionContext.Stub(x => x.PrimaryEntityName).Return("contact");
 pluginExecutionContext.Stub(x => x.PostEntityImages).Return(new EntityImageCollection
 {
 { "PostCreateImage", new Microsoft.Xrm.Sdk.Entity("contact")
 {
 Attributes = { { "parentcustomerid", new EntityReference("account", accountId) } }
 }
 }
 });

// ITracingService
 var tracingService = MockRepository.GenerateStub<ITracingService>();
 tracingService.Stub(x => x.Trace(null, null)).IgnoreArguments().Do((Action<string, object[]>)delegate(string f, object[] o)
 {
 Debug.WriteLine(f, o);
 });

// IOrganizationServiceFactory
 var factory = MockRepository.GenerateStub<IOrganizationServiceFactory>();
 factory.Stub(x => x.CreateOrganizationService(null)).IgnoreArguments().Return(service);

// IServiceProvider
 var serviceProvider = MockRepository.GenerateStub<IServiceProvider>();
 serviceProvider.Stub(x => x.GetService(null)).IgnoreArguments().Do((Func<Type, object>)delegate(Type t)
 {
 if (t == typeof(IPluginExecutionContext))
 {
 return pluginExecutionContext;
 }
 else if (t == typeof(ITracingService))
 {
 return tracingService;
 }
 else if (t == typeof(IOrganizationServiceFactory))
 {
 return factory;
 }

return null;
 });

//
 // Act
 //
 target.Execute(serviceProvider);

//
 // Assert
 //
 Assert.AreEqual(expected, actual);
 }

The complete sample code using QUnit can be downloaded from MSDN sample gallery: http://code.msdn.microsoft.com/Dynamics-CRM-2011-client-9f189663

This post describe how to use QUnit and Xrm.Page Script Library Template (Microsoft Visual Studio extension) to unit test Dynamics CRM 2011 client side jQuery or JavaScript code.

More information on Xrm.Page Script Library Templatecan be found: http://msdn.microsoft.com/en-us/library/gg328261.aspx#BKMK_DevelopmentTools

More information on QUnit can be found: http://qunitjs.com/

Suppose we have one JavaScript web resource which will run when account form load. The client side JavaScript code will update the “Account Name” label to “Organisation Name” and set Preferred User look up field value to the Preferred User of the Primary Contact of the current account.

Code Under Test

/// <reference path="XrmPageTemplate.js" />

//This Library uses a namespace naming strategy to help prevent duplication function names
if (typeof (Zzhou) == "undefined")
{ Zzhou = { __namespace: true }; }
if (typeof (Zzhou.Qunit) == "undefined")
{ Zzhou.Qunit = { __namespace: true }; }
// Namespace container for functions in this library.
Zzhou.Qunit.Account = {
 onload: function () {
 var attrName = 'name',
 label = 'Organisation Name';
 this._changeControlLabel(attrName, label);
 this._updatePreferredUser();
 },
 _changeControlLabel: function (attrName, label) {
 var control = Xrm.Page.getControl(attrName);
 if (control) {
 control.setLabel(label);
 }
 },
 _updatePreferredUser: function () {
 // primary contact look up field name
 var attrName = 'primarycontactid';
 // get primary contact attribute
 var attribute = Xrm.Page.getAttribute(attrName);
 if (attribute) {
 // get primary contact attribute value
 var attrValue = attribute.getValue();
 if (attrValue && attrValue[0] && attrValue[0].entityType === 'contact') {
 // get primary contact id
 var primaryContactId = attrValue[0].id;
 // retrieve primary contact.PreferredSystemUserId
 SDK.JQuery.retrieveRecord(
 primaryContactId,
 "Contact",
 "PreferredSystemUserId",
 null,
 // success call back
 function (user) {
 if (user && user.PreferredSystemUserId) {
 var attrName = 'preferredsystemuserid';
 var attribute = Xrm.Page.getAttribute(attrName);
 if (attribute) {
 var lookupReference = [];
 lookupReference[0] = {};
 lookupReference[0].id = user.PreferredSystemUserId.Id;
 lookupReference[0].entityType = user.PreferredSystemUserId.LogicalName;
 lookupReference[0].name = user.PreferredSystemUserId.Name;

attribute.setValue(lookupReference);
 }
 }
 },
 function (error) {
 alert(error.message);
 }
 );
 }
 }
 },
 __namespace: true
};

Unit Test

/// <reference path="XrmPageTemplate.js" />
module(
 'Account Form Library Test',
 {
 setup: function () {
 this.savedAjax = $.ajax;
 },
 teardown: function () {
 $.ajax = this.savedAjax;
 }
 }
 );
test("Zzhou.Qunit.Account._changeControlLabel", function () {
 //
 // Arrange
 //
 var attrName = 'name',
 expectedLabel = 'Organisation Name';
 //
 // Act
 //
 Zzhou.Qunit.Account._changeControlLabel(attrName, expectedLabel);

//
 // Assert
 //
 var actualLabel, control = Xrm.Page.getControl(attrName);
 if (control) {
 actualLabel = control.getLabel();
 }
 strictEqual(actualLabel, expectedLabel, "actualLabel and expectedLabel are the same value and type");
});
test("Zzhou.Qunit.Account._updatePreferredUser", function () {
 expect(3);

//
 // Arrange
 //
 var data = {
 d: {
 PreferredSystemUserId: {
 Id: '5bcf7e47-9993-e111-88fa-00155d4c5b01',
 LogicalName: 'systemuser',
 Name: 'First name Last name'
 }
 }
 };
 $.ajax = function (options) {
 options.success(data, "success", { responseText: JSON.stringify(data) });
 };

//
 // Act
 //
 Zzhou.Qunit.Account._updatePreferredUser();

//
 // Assert
 //
 var attrName = 'preferredsystemuserid';
 var attribute = Xrm.Page.getAttribute(attrName);
 if (attribute) {
 var attrValue = attribute.getValue();
 if (attrValue && attrValue[0]) {
 strictEqual(attrValue[0].entityType, data.d.PreferredSystemUserId.LogicalName);
 strictEqual(attrValue[0].id, data.d.PreferredSystemUserId.Id);
 strictEqual(attrValue[0].name, data.d.PreferredSystemUserId.Name);
 }
 }
});

A fix can be found from the following link

http://community.dynamics.com/product/crm/f/117/t/93178.aspx

Microsoft just provided me with a work around while they work on the hot fix.

• Change the Anonymous user identity of IIS Anonymous Authentication Credentials to Application pool Identity option:

1. On the CRM server, open the Internet Information Services (IIS) Manager;

2. In IIS Manager, click the CRM site;

3. In the Features View, double-click Authentication;

4. Select Anonymous Authentication , and then click Edit in the Actions pane;

5. In the Edit Anonymous Authentication Credentials dialog box, click the Application pool Identity , and then click Ok;

6. Do an IISRESET on CRM and ADFS server.

I have on premise IFD deployment, after install Rollup Update 11, it is not working, i keep get the following errors

Microsoft CRM Error Report:
Error Description:
Failed to get priv user group information. k = 1b813725-c917-4291-bcea-277fca8e799e privUserGroupId: 5140579c-a508-40a3-943b-fed25dac4842, localSystemAdGuid: 00000000-0000-0000-0000-000000000000, Exception: Microsoft.Crm.CrmSecurityException: Could not find GUID for server: VMCRM$ With SearchFilter:samAccountName at Microsoft.Crm.SecurityUtils.GetGuid(String searchItem, String searchFilter, String searchItemLogInfo, Boolean exceptionIfNotfound) at Microsoft.Crm.SecurityUtils.GetLocalSystemGuid() at Microsoft.Crm.Caching.OrganizationSettingsCacheLoader.LoadCacheData(Guid key, ExecutionContext context).

Error Details:
Failed to get priv user group information. k = 1b813725-c917-4291-bcea-277fca8e799e privUserGroupId: 5140579c-a508-40a3-943b-fed25dac4842, localSystemAdGuid: 00000000-0000-0000-0000-000000000000, Exception: Microsoft.Crm.CrmSecurityException: Could not find GUID for server: VMCRM$ With SearchFilter:samAccountName
 at Microsoft.Crm.SecurityUtils.GetGuid(String searchItem, String searchFilter, String searchItemLogInfo, Boolean exceptionIfNotfound)
 at Microsoft.Crm.SecurityUtils.GetLocalSystemGuid()
 at Microsoft.Crm.Caching.OrganizationSettingsCacheLoader.LoadCacheData(Guid key, ExecutionContext context).

Full Stack:
[CrmSecurityException: Could not find GUID for server: VMCRM$ With SearchFilter:samAccountName]
 at Microsoft.Crm.SecurityUtils.GetGuid(String searchItem, String searchFilter, String searchItemLogInfo, Boolean exceptionIfNotfound)
 at Microsoft.Crm.SecurityUtils.GetLocalSystemGuid()
 at Microsoft.Crm.Caching.OrganizationSettingsCacheLoader.LoadCacheData(Guid key, ExecutionContext context)

[CrmException: Failed to get priv user group information. k = 1b813725-c917-4291-bcea-277fca8e799e privUserGroupId: 5140579c-a508-40a3-943b-fed25dac4842, localSystemAdGuid: 00000000-0000-0000-0000-000000000000, Exception: Microsoft.Crm.CrmSecurityException: Could not find GUID for server: VMCRM$ With SearchFilter:samAccountName
 at Microsoft.Crm.SecurityUtils.GetGuid(String searchItem, String searchFilter, String searchItemLogInfo, Boolean exceptionIfNotfound)
 at Microsoft.Crm.SecurityUtils.GetLocalSystemGuid()
 at Microsoft.Crm.Caching.OrganizationSettingsCacheLoader.LoadCacheData(Guid key, ExecutionContext context).]
 at Microsoft.Crm.Caching.OrganizationSettingsCacheLoader.LoadCacheData(Guid key, ExecutionContext context)
 at Microsoft.Crm.Caching.ObjectModelCacheLoader`2.LoadCacheData(TKey key, IOrganizationContext context)
 at Microsoft.Crm.Caching.CrmMultiOrgCache`2.CreateEntry(TKey key, IOrganizationContext context)
 at Microsoft.Crm.Caching.CrmMultiOrgCache`2.LookupEntry(TKey key, IOrganizationContext context)
 at Microsoft.Crm.Authentication.Claims.ClaimsUtility.GetAuthenticationMethod(Guid organizationId, String method)
 at Microsoft.Crm.Authentication.Claims.CrmFederatedAuthenticationModule.SendToIdentityProvider(RedirectLocation redirectLocation)
 at Microsoft.Crm.Authentication.Claims.CrmFederatedAuthenticationModule.OnEndRequestHandler(Object sender, EventArgs e)
 at System.Web.HttpApplication.SyncEventExecutionStep.System.Web.HttpApplication.IExecutionStep.Execute()
 at System.Web.HttpApplication.ExecuteStep(IExecutionStep step, Boolean& completedSynchronously)
Other Message:

Error Number:
0x80040216

Source File:
Not available

Line Number:
Not available

Error Trace:

 

Date: 10-30-2012

Time: 20:09:56

Server: default.zhongchenzhou.com
Request URL:

https://default.zhongchenzhou.com/default.aspx

This is caused by a script error in file

~\Tools\Solution\import\SolutionImportProcess.aspx

function window.onload() {

After change the code to

window.onload = function () {

Another error comes

If click on cancel, another error comes

Anyone know how to fix this?

Kendo UI is a HTML5, jQuery-based framework for building modern HTML apps. Kendo UI combines the best of emerging HTML5, CSS3, and JavaScript technologies with robust, cross-browser techniques to deliver a framework that is both powerfully rich and broadly compatible with older browsers.

Microsoft Dynamics CRM 2011 Release 8 include support for IE, Chrome, Firefox and Safari.

By using a powerful JavaScript framework, the use of ASP.NET is reduced which would remove the complexity of deployment which also makes the solution much more portable.

By using Kendo UI DataSource, Kendo UI Grid with Dynamics CRM 2011 REST Endpoint, it is easy to implement server side filter, sorting and paging.

There are a few tricks to use Kendo UI together with Dynamics CRM 2011 I want to share. The complete code is in the end of this post.

1. Microsoft Dynamics CRM 2011 REST Endpoint does not support $format system query option.

You can use a global jQuery ajax event handler to specifying http header ensures that the results will be returned as JSON.

$(document).ajaxSend(function (e, jqxhr, settings) {
 if (settings.url.toLowerCase().indexOf("XRMServices/2011/OrganizationData.svc".toLowerCase()) >= 0) {
 jqxhr.setRequestHeader("Accept", "application/json");
 }
});

2. Microsoft Dynamics CRM 2011 REST Endpoint does not support $inlinecount, $count system query option.

you can set a function to use fetch xml and soap endpoint to return the total record count.

var dataSource = new kendo.data.DataSource({
 schema: {
 total: function (data) {
var fetchXml = '<fetch mapping="logical" aggregate="true">' +
 '<entity name="account">' +
 "<attribute name='accountid' alias='count' aggregate='count'/>" +
 '</entity>' +
 '</fetch>';

var context = GetGlobalContext();

var serverUrl = window.parent.document.location.protocol + '//' + window.parent.document.location.host + '/' + context.getOrgUniqueName();

var _oService = new FetchUtil(context.getOrgUniqueName(), serverUrl);
 var res = _oService.Fetch(fetchXml);

var count = res[0].attributes.count.formattedValue;

return count;
 }
 }
});

3. you need to stop Kendo UI to send default query string parameter and use Dynamics CRM 2011 specific format

var dataSource = new kendo.data.DataSource({
 transport: {
 parameterMap: function (options) {
 return {
 $top: options.take,
 $skip: options.skip,
 $select: 'Name,Telephone1,Address1_City'',
 $orderby: options.sort[0].field + ' ' + options.sort[0].dir
 };
 }
 }
});

4. you have to parse returned json object to return object array that Kendo UI understand

var dataSource = new kendo.data.DataSource({
 schema: {
 parse: function (data) {
 return data.d.results;
 },
 type: "json"
 }
});

Complete Kendo UI DataSource code

var context = GetGlobalContext();

var serverUrl = window.parent.document.location.protocol + '//' + window.parent.document.location.host + '/' + context.getOrgUniqueName();

dataSource = new kendo.data.DataSource({
 transport: {
 read: {
 url: serverUrl + "/XRMServices/2011/OrganizationData.svc/AccountSet",
 dataType: 'json'
 },
 parameterMap: function (options) {
 var parameter = {
 $top: options.take,
 $skip: options.skip,
 $select: 'Name,Telephone1,Address1_City',
 $orderby: options.sort[0].field + ' ' + options.sort[0].dir
 };

return parameter;
 }
 },
 schema: {
 model: {
 id: "AccountId",
 fields: {
 Name: { type: "string" },
 Telephone1: { type: "string" },
 Address1_City: { type: "string" }
 }
 },
 total: function (data) {

var fetchXml = '<fetch mapping="logical" aggregate="true">' +
 '<entity name="account">' +
 "<attribute name='accountid' alias='count' aggregate='count'/>" +
 '</entity>' +
 '</fetch>';

var _oService = new FetchUtil(context.getOrgUniqueName(), serverUrl);
 var res = _oService.Fetch(fetchXml);

var count = res[0].attributes.count.formattedValue;

return count;
 },
 parse: function (data) {
 return data.d.results;
 },
 type: "json"
 },
 serverPaging: true,
 pageSize: 10,
 serverSorting: true,
 sort: { field: "Name", dir: "asc" }
 });

Complete Sample code

<!DOCTYPE html>

<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
 <meta charset="utf-8" />
 <title>Kendo UI Demo</title>
 <!-- CDN-based stylesheet references for Kendo UI Web -->
 <link rel="stylesheet" href="http://cdn.kendostatic.com/2012.2.913/styles/kendo.common.min.css" />
 <link rel="stylesheet" href="http://cdn.kendostatic.com/2012.2.913/styles/kendo.default.min.css" />
</head>
<body style="border-width: 0px; padding-left: 0px; padding-top: 0px; margin-left: 0px; margin-top: 0px; margin-bottom: 0px; margin-right: 0px">
 <div id="grid"></div>
 <!-- CDN-based script reference for jQuery -->
 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
 <!-- CDN-based script reference for Kendo UI DataViz -->
 <script type="text/javascript" src="http://cdn.kendostatic.com/2012.2.913/js/kendo.web.min.js"></script>
 <script type="text/javascript" src="ClientGlobalContext.js.aspx"></script>
 <script type="text/javascript">
 $(document).ready(function ($) {

var context = GetGlobalContext();

var serverUrl = window.parent.document.location.protocol + '//' + window.parent.document.location.host + '/' + context.getOrgUniqueName();

dataSource = new kendo.data.DataSource({
 transport: {
 read: {
 url: serverUrl + "/XRMServices/2011/OrganizationData.svc/AccountSet",
 dataType: 'json'
 },
 parameterMap: function (options) {
 var parameter = {
 $top: options.take,
 $skip: options.skip,
 $select: 'Name,Telephone1,Address1_City',
 $orderby: options.sort[0].field + ' ' + options.sort[0].dir
 };

return parameter;
 }
 },
 schema: {
 model: {
 id: "AccountId",
 fields: {
 Name: { type: "string" },
 Telephone1: { type: "string" },
 Address1_City: { type: "string" }
 }
 },
 total: function (data) {

var fetchXml = '<fetch mapping="logical" aggregate="true">' +
 '<entity name="account">' +
 "<attribute name='accountid' alias='count' aggregate='count'/>" +
 '</entity>' +
 '</fetch>';

var _oService = new FetchUtil(context.getOrgUniqueName(), serverUrl);
 var res = _oService.Fetch(fetchXml);

var count = res[0].attributes.count.formattedValue;

return count;
 },
 parse: function (data) {
 return data.d.results;
 },
 type: "json"
 },
 serverPaging: true,
 pageSize: 10,
 serverSorting: true,
 sort: { field: "Name", dir: "asc" }
 });

var grid = $("#grid").kendoGrid({
 dataSource: dataSource,
 height: 450,
 columns: [{
 template: '<input type="checkbox" />',
 sortable: false,
 width: 45
 },
 {
 title: 'Account Name',
 field: "Name",
 width: 180
 },
 {
 title: 'Main Phone',
 field: "Telephone1",
 width: 300
 },
 {
 title: 'Address 1: City',
 field: "Address1_City",
 filterable: false,
 width: 300,
 sortable: false
 }],
 editable: false,
 pageable: true,
 selectable: "multiple, row",
 sortable: {
 mode: 'single',
 allowUnsort: false
 },
 dataBound: function () {
 grid.table.find("tr").find("td:first input")
 .change(function (e) {
 if (!$(this).prop('checked')) {
 grid.clearSelection();
 }
 });
 },
 change: function (e) {
 window.setTimeout(function () {
 var checkbox = $(e.sender.select()[0]).find("td:first input").prop("checked", true);
 grid.table.find("tr").find("td:first input:checked").not(checkbox).prop("checked", false);
 }, 0);
 }
 }).data("kendoGrid");

grid.thead.find("th:first")
 .append($('<input class="selectAll" type="checkbox"/>'))
 .delegate(".selectAll", "click", function () {
 var checkbox = $(this);

grid.table.find("tr")
 .find("td:first input")
 .attr("checked", checkbox.is(":checked"))
 .trigger("change");
 });
 }).ajaxSend(function (e, jqxhr, settings) {
 if (settings.url.toLowerCase().indexOf("XRMServices/2011/OrganizationData.svc".toLowerCase()) >= 0) {
 jqxhr.setRequestHeader("Accept", "application/json");
 }
 });
 </script>
 <script id="FetchUtil" type="text/javascript">
 var XMLHTTPSUCCESS = 200;
 var XMLHTTPREADY = 4;

function FetchUtil(sOrg, sServer) {
 this.org = sOrg;
 this.server = sServer;

if (sOrg == null) {
 if (typeof (ORG_UNIQUE_NAME) != "undefined") {
 this.org = ORG_UNIQUE_NAME;
 }
 }

if (sServer == null) {
 this.server = window.location.protocol + "//" + window.location.host;
 }
 }

FetchUtil.prototype._ExecuteRequest = function (sXml, sMessage, fInternalCallback, fUserCallback) {
 var xmlhttp = new XMLHttpRequest();
 xmlhttp.open("POST", this.server + "/XRMServices/2011/Organization.svc/web", (fUserCallback != null));
 xmlhttp.setRequestHeader("Accept", "application/xml, text/xml, */*");
 xmlhttp.setRequestHeader("Content-Type", "text/xml; charset=utf-8");
 xmlhttp.setRequestHeader("SOAPAction", "http://schemas.microsoft.com/xrm/2011/Contracts/Services/IOrganizationService/Execute");

if (fUserCallback != null) {
 //asynchronous: register callback function, then send the request.
 var crmServiceObject = this;
 xmlhttp.onreadystatechange = function () {
 fInternalCallback.call(crmServiceObject, xmlhttp, fUserCallback)
 };
 xmlhttp.send(sXml);
 } else {
 //synchronous: send request, then call the callback function directly
 xmlhttp.send(sXml);
 return fInternalCallback.call(this, xmlhttp, null);
 }
 }

FetchUtil.prototype._HandleErrors = function (xmlhttp) {
 /// <summary>(private) Handles xmlhttp errors</summary>
 if (xmlhttp.status != XMLHTTPSUCCESS) {
 var sError = "Error: " + xmlhttp.responseText + " " + xmlhttp.statusText;
 alert(sError);
 return true;
 } else {
 return false;
 }
 }

FetchUtil.prototype.Fetch = function (sFetchXml, fCallback) {
 /// <summary>Execute a FetchXml request. (result is the response XML)</summary>
 /// <param name=”sFetchXml”>fetchxml string</param>
 /// <param name=”fCallback” optional=”true” type=”function”>(Optional) Async callback function if specified. If left null, function is synchronous </param>

var request = "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">";
 request += "<s:Body>";

request += '<Execute xmlns="http://schemas.microsoft.com/xrm/2011/Contracts/Services">' + '<request i:type="b:RetrieveMultipleRequest" ' + ' xmlns:b="http://schemas.microsoft.com/xrm/2011/Contracts" ' + ' xmlns:i="http://www.w3.org/2001/XMLSchema-instance">' + '<b:Parameters xmlns:c="http://schemas.datacontract.org/2004/07/System.Collections.Generic">' + '<b:KeyValuePairOfstringanyType>' + '<c:key>Query</c:key>' + '<c:value i:type="b:FetchExpression">' + '<b:Query>';

request += CrmEncodeDecode.CrmXmlEncode(sFetchXml);

request += '</b:Query>' + '</c:value>' + '</b:KeyValuePairOfstringanyType>' + '</b:Parameters>' + '<b:RequestId i:nil="true"/>' + '<b:RequestName>RetrieveMultiple</b:RequestName>' + '</request>' + '</Execute>';

request += '</s:Body></s:Envelope>';

return this._ExecuteRequest(request, "Fetch", this._FetchCallback, fCallback);
 }

FetchUtil.prototype._FetchCallback = function (xmlhttp, callback) {
 ///<summary>(private) Fetch message callback.</summary>
 //xmlhttp must be completed
 if (xmlhttp.readyState != XMLHTTPREADY) {
 return;
 }

//check for server errors
 if (this._HandleErrors(xmlhttp)) {
 return;
 }

var sFetchResult = xmlhttp.responseXML.selectSingleNode("//a:Entities").xml;

var resultDoc = new ActiveXObject("Microsoft.XMLDOM");
 resultDoc.async = false;
 resultDoc.loadXML(sFetchResult);

//parse result xml into array of jsDynamicEntity objects
 var results = new Array(resultDoc.firstChild.childNodes.length);

for (var i = 0; i < resultDoc.firstChild.childNodes.length; i++) {
 var oResultNode = resultDoc.firstChild.childNodes[i];
 var jDE = new jsDynamicEntity();
 var obj = new Object();

for (var j = 0; j < oResultNode.childNodes.length; j++) {
 switch (oResultNode.childNodes[j].baseName) {
 case "Attributes":
 var attr = oResultNode.childNodes[j];

for (var k = 0; k < attr.childNodes.length; k++) {

// Establish the Key for the Attribute
 var sKey = attr.childNodes[k].firstChild.text;
 var sType = '';

// Determine the Type of Attribute value we should expect
 for (var l = 0; l < attr.childNodes[k].childNodes[1].attributes.length; l++) {
 if (attr.childNodes[k].childNodes[1].attributes[l].baseName == 'type') {
 sType = attr.childNodes[k].childNodes[1].attributes[l].text;
 }
 }

switch (sType) {
 case "a:OptionSetValue":
 var entOSV = new jsOptionSetValue();
 entOSV.type = sType;
 entOSV.value = attr.childNodes[k].childNodes[1].text;
 obj[sKey] = entOSV;
 break;

case "a:EntityReference":
 var entRef = new jsEntityReference();
 entRef.type = sType;
 entRef.guid = attr.childNodes[k].childNodes[1].childNodes[0].text;
 entRef.logicalName = attr.childNodes[k].childNodes[1].childNodes[1].text;
 entRef.name = attr.childNodes[k].childNodes[1].childNodes[2].text;
 obj[sKey] = entRef;
 break;

default:
 var entCV = new jsCrmValue();
 entCV.type = sType;
 entCV.value = attr.childNodes[k].childNodes[1].text;
 obj[sKey] = entCV;

break;
 }
 }

jDE.attributes = obj;
 break;

case "Id":
 jDE.guid = oResultNode.childNodes[j].text;
 break;

case "LogicalName":
 jDE.logicalName = oResultNode.childNodes[j].text;
 break;

case "FormattedValues":
 var foVal = oResultNode.childNodes[j];

for (var k = 0; k < foVal.childNodes.length; k++) {
 // Establish the Key, we are going to fill in the formatted value of the already found attribute
 var sKey = foVal.childNodes[k].firstChild.text;

jDE.attributes[sKey].formattedValue = foVal.childNodes[k].childNodes[1].text;
 }
 break;
 }
 }
 results[i] = jDE;
 }

//return entities
 if (callback != null) callback(results);
 else return results;
 }

function jsDynamicEntity(gID, sLogicalName) {
 this.guid = gID;
 this.logicalName = sLogicalName;
 this.attributes = new Object();
 }

function jsCrmValue(sType, sValue) {
 this.type = sType;
 this.value = sValue;
 }

function jsEntityReference(gID, sLogicalName, sName) {
 this.guid = gID;
 this.logicalName = sLogicalName;
 this.name = sName;
 this.type = 'EntityReference';
 }

function jsOptionSetValue(iValue, sFormattedValue) {
 this.value = iValue;
 this.formattedValue = sFormattedValue;
 this.type = 'OptionSetValue';
 }
</script>
</body>
</html>

This is because the solution package is large and the SQL Server is slow and someone enabled CRM Server tracing.

I have find a solution from this link: http://blogs.msdn.com/b/darrenliu/archive/2011/07/08/crm-2011-cannot-publish-customizations-after-import.aspx

The cause for this problem is mentioned in that blog: “CRM has a default timeout value of 300 seconds = 5 minutes. If any process takes more than 5 minutes, it’ll stop.”

This is also mentioned in the SDK as well. http://msdn.microsoft.com/en-us/library/gg334495.aspx#BKMK_MaxSizeOfSolution

Change the maximum allowed size by editing the <httpRuntime> element in the web.config file for the application. Edit the executionTimeout and maxRequestLength attributes to allow for the necessary size.

The solution mentioned in the blog will solve the problem as well, but it is a bit outdated.

Dynamics CRM 2011 web.config file use location element, so we can fix the problem by update root web.config file.

One of the fix mentioned in that post might be already fix depend on your Roll Up version.

The complete steps are listed below:

1. On the CRM application server, open Internet Information Services (IIS) Manager.
2. Expand the server name, and then expand Web Sites.
3. Right-click the Microsoft CRM Web site, and then click Open.
4. Right-click the Web.config file, click Open With, and then click Notepad.
5. In Notepad, find

<system.web>
 <httpRuntime executionTimeout="300" maxRequestLength="32768" requestValidationMode="3.0" encoderType="Microsoft.Crm.CrmHttpEncoder, Microsoft.Crm" />

change to

 <system.web>
 <httpRuntime executionTimeout="300" maxRequestLength="32768" requestValidationMode="3.0" encoderType="Microsoft.Crm.CrmHttpEncoder, Microsoft.Crm" />

find

 <location path="MSCRMServices">
 <system.web>
 <httpRuntime maxRequestLength="8192" />

change to

 <location path="MSCRMServices">
 <system.web>
 <httpRuntime maxRequestLength="32768" />

PS > Add-PSSnapin Microsoft.Crm.PowerShell
 PS > $web = Get-CrmSetting WebAddressSettings
 PS > $web.HelpServerUrl = ""
 PS > Set-CrmSetting $web

C#

var service = Microsoft.Xrm.Sdk.Deployment.Proxy.ProxyClientHelper.CreateClient(new System.Uri("http://crm2011:5555/XRMDeployment/2011/Deployment.svc"));

var webAddressSettings = (Microsoft.Xrm.Sdk.Deployment.WebAddressSettings)service.Retrieve(Microsoft.Xrm.Sdk.Deployment.DeploymentEntityType.WebAddressSettings, null);

webAddressSettings.HelpServerUrl = "http://crm2011:5555";

service.Update(webAddressSettings);

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

Unit test CRM workflow activity is similar to unit test CRM plugin in terms of the interface we have to mock. There are three distinct points in any code activity unit test, first is how to correctly invoke Execute method since it is protected, second is how to pass in the InArgument parameters and the last is how to pass in required service as extensions.

1. Correctly invoke CodeActivity.Execute(CodeActivityContext executionContext)

Since CodeActivity.Execute(CodeActivityContext executionContext) is protected, the correct way to invoke is method is to construct an instance of System.Activities.WorkflowInvoker and pass in an instance of custom code workflow activity. we can call the Invoke method on the WorkflowInvoker instance to trigger the execution of CodeActivity.Execute method.

AddMemberTeamActivity target = new AddMemberTeamActivity();

var invoker = new WorkflowInvoker(target);

var outputs = invoker.Invoke(inputs);

2. Correctly pass in InArgument<T> properties

the InArgument<T> properties need to be passed in as a dictionary when call WorkflowInvoker.Invoke method

var inputs = new Dictionary<string, object>
 {
 { "User", new EntityReference("systemuser", expectedUserId) },
 { "Team", new EntityReference("team", expectedTeamId) }
 };

var outputs = invoker.Invoke(inputs);

3. Pass in required service as extensions

required service can be added to WorkflowInvoker.Extensions property

var invoker = new WorkflowInvoker(target);
 invoker.Extensions.Add<ITracingService>(() => tracingService);
 invoker.Extensions.Add<IWorkflowContext>(() => workflowContext);
 invoker.Extensions.Add<IOrganizationServiceFactory>(() => factory);

Code Under Test

public sealed class AddMemberTeamActivity : CodeActivity
 {
 [RequiredArgument]
 [Input("User to Add")]
 [ReferenceTarget("systemuser")]
 public InArgument<EntityReference> User { get; set; }

[RequiredArgument]
 [Input("Team to Add To")]
 [ReferenceTarget("team")]
 public InArgument<EntityReference> Team { get; set; }

/// <summary>
 /// Executes the workflow activity.
 /// </summary>
 /// <param name="executionContext">The execution context.</param>
 protected override void Execute(CodeActivityContext executionContext)
 {
 // Create the tracing service
 ITracingService tracingService = executionContext.GetExtension<ITracingService>();

if (tracingService == null)
 {
 throw new InvalidPluginExecutionException("Failed to retrieve tracing service.");
 }

tracingService.Trace("Entered AddMemberTeamActivity.Execute(), Activity Instance Id: {0}, Workflow Instance Id: {1}",
 executionContext.ActivityInstanceId,
 executionContext.WorkflowInstanceId);

// Create the context
 IWorkflowContext context = executionContext.GetExtension<IWorkflowContext>();

if (context == null)
 {
 throw new InvalidPluginExecutionException("Failed to retrieve workflow context.");
 }

tracingService.Trace("AddMemberTeamActivity.Execute(), Correlation Id: {0}, Initiating User: {1}",
 context.CorrelationId,
 context.InitiatingUserId);

IOrganizationServiceFactory serviceFactory = executionContext.GetExtension<IOrganizationServiceFactory>();
 IOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);

try
 {
 EntityReference user = this.User.Get(executionContext);
 EntityReference team = this.Team.Get(executionContext);

if (!IsMemberInTeam(service, team.Id, user.Id))
 {
 OrganizationRequest request = new AddMembersTeamRequest { MemberIds = new Guid[] { user.Id }, TeamId = team.Id };

var response = service.Execute(request) as AddMembersTeamResponse;
 }
 }
 catch (FaultException<OrganizationServiceFault> e)
 {
 tracingService.Trace("Exception: {0}", e.ToString());

// Handle the exception.
 throw;
 }

tracingService.Trace("Exiting AddMemberTeamActivity.Execute(), Correlation Id: {0}", context.CorrelationId);
 }

internal bool IsMemberInTeam(IOrganizationService service, Guid teamId, Guid memberId)
 {
 OrganizationServiceContext context = new OrganizationServiceContext(service);

var query = from relationship in context.CreateQuery("teammembership")
 where relationship.GetAttributeValue<Guid>("teamid") == teamId
 && relationship.GetAttributeValue<Guid>("systemuserid") == memberId
 select relationship;

return query.FirstOrDefault() != null;
 }
 }

Unit Test

[TestClass]
 public class AddMemberTeamActivityTest
 {
 [TestMethod]
 public void ExecuteTest()
 {
 //
 // Arrange
 //
 Guid actualUserId = Guid.NewGuid();
 Guid actualTeamId = Guid.NewGuid();
 var workflowUserId = Guid.NewGuid();
 var workflowCorrelationId = Guid.NewGuid();
 var workflowInitiatingUserId = Guid.NewGuid();

// IOrganizationService
 var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();
 service.ExecuteOrganizationRequest = r =>
 {
 AddMembersTeamRequest request = r as AddMembersTeamRequest;
 actualUserId = request.MemberIds[0];
 actualTeamId = request.TeamId;
 return new AddMembersTeamResponse();
 };

// IWorkflowContext
 var workflowContext = new Microsoft.Xrm.Sdk.Workflow.Fakes.StubIWorkflowContext();
 workflowContext.UserIdGet = () =>
 {
 return workflowUserId;
 };
 workflowContext.CorrelationIdGet = () =>
 {
 return workflowCorrelationId;
 };
 workflowContext.InitiatingUserIdGet = () =>
 {
 return workflowInitiatingUserId;
 };

// ITracingService
 var tracingService = new Microsoft.Xrm.Sdk.Fakes.StubITracingService();
 tracingService.TraceStringObjectArray = (f, o) =>
 {
 Debug.WriteLine(f, o);
 };

// IOrganizationServiceFactory
 var factory = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationServiceFactory();
 factory.CreateOrganizationServiceNullableOfGuid = id =>
 {
 return service;
 };

var expectedUserId = Guid.NewGuid();
 var expectedTeamId = Guid.NewGuid();

AddMemberTeamActivity target = new AddMemberTeamActivity();
 using (ShimsContext.Create())
 {
 var fakeTarget = new DynamicsCRMUnitTest.Workflow.Fakes.ShimAddMemberTeamActivity(target);
 fakeTarget.IsMemberInTeamIOrganizationServiceGuidGuid = (svc, teamId, memberId) =>
 {
 return false;
 };

var invoker = new WorkflowInvoker(target);
 invoker.Extensions.Add<ITracingService>(() => tracingService);
 invoker.Extensions.Add<IWorkflowContext>(() => workflowContext);
 invoker.Extensions.Add<IOrganizationServiceFactory>(() => factory);

var inputs = new Dictionary<string, object>
 {
 { "User", new EntityReference("systemuser", expectedUserId) },
 { "Team", new EntityReference("team", expectedTeamId) }
 };

//
 // Act
 //
 var outputs = invoker.Invoke(inputs);
 }

//
 // Assert
 //
 Assert.AreEqual(expectedUserId, actualUserId);
 Assert.AreEqual(expectedTeamId, actualTeamId);
 }

[TestMethod]
 public void IsMemberInTeamTest()
 {
 //
 // Arrange
 //
 Guid userId = Guid.NewGuid();
 Guid teamId = Guid.NewGuid();
 bool expected = true;

AddMemberTeamActivity target = new AddMemberTeamActivity();

// IOrganizationService
 var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();
 service.ExecuteOrganizationRequest = r =>
 {
 List<Entity> entities = new List<Entity>
 {
 new Entity()
 };

var response = new RetrieveMultipleResponse
 {
 Results = new ParameterCollection
 {
 { "EntityCollection", new EntityCollection(entities) }
 }
 };

return response;
 };

//
 // Act
 //
 var actual = target.IsMemberInTeam(service, teamId, userId);

//
 // Assert
 //
 Assert.AreEqual(expected, actual);
 }
 }

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

Unit test CRM plugin is straightforward as well, it is just a bit tedious. IPlugin.Execute only accept one parameter which is IServiceProvider. Through IServiceProvider we can retrieve at least 3 interface and we need to set up 5 interface, which will be IOrganizationService, IPluginExecutionContext, ITracingService, IOrganizationServiceFactory and IServiceProvider.

Suppose we have a sample Dynamics CRM plugin, which is called after a contact is created within Dynamics CRM, if the parent customer is set to an account, the number of employees attribute of that account will be increased by one.

Code Under Test

public class Plugin : IPlugin
 {
 private string _unsecure, _secure;

/// <summary>
 /// Alias of the image registered for the snapshot of the
 /// primary entity's attributes after the core platform operation executes.
 /// The image contains the following attributes:
 /// parentcustomerid
 ///
 /// Note: Only synchronous post-event and asynchronous registered plug-ins
 /// have PostEntityImages populated.
 /// </summary>
 private readonly string postImageAlias = "PostCreateImage";

public Plugin(string unsecure, string secure)
 {
 _unsecure = unsecure;
 _secure = secure;
 }

public void Execute(IServiceProvider serviceProvider)
 {
 // Obtain the execution context service from the service provider.
 var pluginExecutionContext = (IPluginExecutionContext)serviceProvider.GetService(typeof(IPluginExecutionContext));

if (pluginExecutionContext.Stage == 40 && pluginExecutionContext.MessageName == "Create" && pluginExecutionContext.PrimaryEntityName == "contact")
 {
 // Obtain the tracing service from the service provider.
 var tracingService = (ITracingService)serviceProvider.GetService(typeof(ITracingService));

// Obtain the Organization Service factory service from the service provider
 IOrganizationServiceFactory factory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));

// Use the factory to generate the Organization Service.
 var organizationService = factory.CreateOrganizationService(pluginExecutionContext.UserId);

Entity postImageEntity = (pluginExecutionContext.PostEntityImages != null && pluginExecutionContext.PostEntityImages.Contains(this.postImageAlias)) ? pluginExecutionContext.PostEntityImages[this.postImageAlias] : null;

// when a contact is created with parent account, increase number of employees for that account
 if (postImageEntity != null && postImageEntity.Contains("parentcustomerid"))
 {
 EntityReference parentCustomer = postImageEntity.GetAttributeValue<EntityReference>("parentcustomerid");

if (parentCustomer != null && parentCustomer.LogicalName.ToLowerInvariant() == "account")
 {
 tracingService.Trace("Parent account id: {0}.", parentCustomer.Id);

Entity parentAccount = organizationService.Retrieve("account", parentCustomer.Id, new Microsoft.Xrm.Sdk.Query.ColumnSet("numberofemployees"));

int numberOfEmployees = 0;
 if (parentAccount.Contains("numberofemployees"))
 {
 numberOfEmployees = parentAccount.GetAttributeValue<int>("numberofemployees");
 }

parentAccount["numberofemployees"] = numberOfEmployees + 1;

organizationService.Update(parentAccount);
 }
 }
 }
 }
 }

Unit Test

[TestClass]
 public class PluginTest
 {
 /// <summary>
 ///A test for Execute
 ///</summary>
 [TestMethod()]
 public void ExecuteTest()
 {
 //
 // Arrange
 //
 string unsecure = "unsecure";
 string secure = "secure";
 Plugin target = new Plugin(unsecure, secure);

var accountId = Guid.NewGuid();
 var previousNumber = 3;
 var expected = 4;
 var actual = 0;

// IOrganizationService
 var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();
 service.RetrieveStringGuidColumnSet = (entityName, id, columns) =>
 {
 return new Microsoft.Xrm.Sdk.Entity("account")
 {
 Id = accountId,
 Attributes = { { "numberofemployees", previousNumber } }
 };
 };
 service.UpdateEntity = (entity) =>
 {
 actual = entity.GetAttributeValue<int>("numberofemployees");
 };

// IPluginExecutionContext
 var pluginExecutionContext = new Microsoft.Xrm.Sdk.Fakes.StubIPluginExecutionContext();
 pluginExecutionContext.StageGet = () => { return 40; };
 pluginExecutionContext.MessageNameGet = () => { return "Create"; };
 pluginExecutionContext.PrimaryEntityNameGet = () => { return "contact"; };
 pluginExecutionContext.PostEntityImagesGet = () =>
 {
 return new EntityImageCollection
 {
 { "PostCreateImage", new Microsoft.Xrm.Sdk.Entity("contact")
 {
 Attributes = { { "parentcustomerid", new EntityReference("account", accountId) } }
 }
 }
 };
 };

// ITracingService
 var tracingService = new Microsoft.Xrm.Sdk.Fakes.StubITracingService();
 tracingService.TraceStringObjectArray = (f, o) =>
 {
 Debug.WriteLine(f, o);
 };

// IOrganizationServiceFactory
 var factory = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationServiceFactory();
 factory.CreateOrganizationServiceNullableOfGuid = id =>
 {
 return service;
 };

// IServiceProvider
 var serviceProvider = new System.Fakes.StubIServiceProvider();
 serviceProvider.GetServiceType = t =>
 {
 if (t == typeof(IPluginExecutionContext))
 {
 return pluginExecutionContext;
 }
 else if (t == typeof(ITracingService))
 {
 return tracingService;
 }
 else if (t == typeof(IOrganizationServiceFactory))
 {
 return factory;
 }

return null;
 };

//
 // Act
 //
 target.Execute(serviceProvider);

//
 // Assert
 //
 Assert.AreEqual(expected, actual);
 }
 }

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

Isolate IOrganizationService method call in unit test code should be very simple and straightforward, since it is a well defined interface. With Microsoft Fakes you can use the generated Stub types contained in the generated fake assembly.

Code Under Test

public class OrganizationServiceMethods
 {
 private IOrganizationService _service;

public OrganizationServiceMethods(IOrganizationService service)
 {
 _service = service;
 }

public IEnumerable<Guid> RetrieveAccountIdByName(string name)
 {
 QueryByAttribute query = new QueryByAttribute("account")
 {
 ColumnSet = new ColumnSet("accountid")
 };
 query.Attributes.Add("name");
 query.Values.Add(name);

var result = _service.RetrieveMultiple(query);

List<Guid> ids = new List<Guid>();

foreach (var entity in result.Entities)
 {
 ids.Add(entity.GetAttributeValue<Guid>("accountid"));
 }

return ids;
 }
 }

Unit Test

[TestMethod]
 public void RetrieveAccountIdByNameTest()
 {
 //
 // Arrange
 //
 IEnumerable<Guid> actual;
 IEnumerable<Guid> expected = new List<Guid> { Guid.NewGuid(), Guid.NewGuid() };

int callCount = 0;

var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();
 service.RetrieveMultipleQueryBase = (query) =>
 {
 callCount++;

var results = new EntityCollection();

results.Entities.AddRange(
 new Entity("account") { Attributes = { { "accountid", expected.ElementAt(0) } } },
 new Entity("account") { Attributes = { { "accountid", expected.ElementAt(1) } } });

return results;
 };

OrganizationServiceMethods target = new OrganizationServiceMethods(service);

//
 // Act
 //
 actual = target.RetrieveAccountIdByName("TestName");

//
 // Assert
 //
 Assert.AreEqual(callCount, 1); // verify OrganizationServiceContext.RetrieveVersion is called once

Assert.AreEqual(expected.Count(), actual.Count());
 Assert.AreEqual(expected.ElementAt(0), actual.ElementAt(0));
 Assert.AreEqual(expected.ElementAt(1), actual.ElementAt(1));
 }

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

In a previous post (Part 4: Microsoft Fakes with CrmOrganizationServiceContext), I have describe how to use run time redirect delegate feature of Microsoft Fakes to unit test CrmOrganizationServiceContext. I consider this a direct approach since you do not need to understand the IOrganizationService API and you do not need to know all the underlining messages. If you know IOrganizationService API and underlining messages, there is also an indirect approach to unit test CrmOrganizationServiceContext, which is to mock the underlining IOrganizationService.

CrmOrganizationServiceContext is SDK Extensions contained in Microsoft.Xrm.Client assembly. CrmOrganizationServiceContext allows the entity objects produced by the data context to participate in the WCF Data Services framework. CrmOrganizationServiceContext provide methods from various OrganizationRequest, which means a method based implementation of the message API. These methods are defined as extension methods, to use these methods we have to include the Microsoft.Xrm.Client.Messages namespace.

For more information on CrmOrganizationServiceContext, see Developer Extensions Context Object Model

CrmOrganizationServiceContext will perform all its method work through IOrganizationService.Execute method. We need to provide an instance of IOrganizationService to construct OrganizationServiceContext, OrganizationServiceContext is going to translate LINQ to CRM query into RetrieveMultipleRequest and execute that OrganizationRequest by calling IOrganizationService.Execute. If we mock IOrganizationService properly, we can isolate LINQ to CRM query unit test.

Code Under Test

public class CrmContextMethods2
 {
 private CrmOrganizationServiceContext _crmContext;

public CrmContextMethods2(IOrganizationService service)
 {
 _crmContext = new CrmOrganizationServiceContext(service);
 }

public string RetrieveVersion()
 {
 var version = _crmContext.RetrieveVersion();

return version;
 }

public Guid CreateAccount(string name)
 {
 var entity = new Entity("account")
 {
 Attributes = new Microsoft.Xrm.Sdk.AttributeCollection
 {
 { "name", name }
 }
 };

var id = _crmContext.Create(entity);

return id;
 }
 }

Unit Test

[TestClass]
 public class CrmContextMethods2Test
 {
 [TestMethod]
 public void CreateAccountTest()
 {
 //
 // Arrange
 //
 string accountName = "abcabcabc";
 Guid actual;
 Guid expected = Guid.NewGuid();

int callCount = 0;
 Entity entity = null;

var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();
 service.CreateEntity = e =>
 {
 callCount++;
 entity = e;
 return expected;
 };

CrmContextMethods2 target = new CrmContextMethods2(service);

//
 // Act
 //
 actual = target.CreateAccount(accountName);

//
 // Assert
 //
 Assert.AreEqual(callCount, 1); // verify OrganizationServiceContext.Create is called once
 Assert.IsNotNull(entity); // verify OrganizationServiceContext.Create is called with not null object
 Assert.AreEqual(entity.LogicalName, "account"); // verify OrganizationServiceContext.Create is called with entity with proper entity name
 Assert.AreEqual(entity.GetAttributeValue<string>("name"), accountName); // verify OrganizationServiceContext.Create is called with entity with proper value set on name attribute

Assert.AreEqual(expected, actual);
 }

[TestMethod]
 public void RetrieveVersionTest()
 {
 //
 // Arrange
 //
 string actual;
 string expected = "5.0.9690.2243";

int callCount = 0;

var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();
 service.ExecuteOrganizationRequest = r =>
 {
 callCount++;

return new RetrieveVersionResponse
 {
 Results = new ParameterCollection
 {
 { "Version", expected }
 }
 };
 };

CrmContextMethods2 target = new CrmContextMethods2(service);

//
 // Act
 //
 actual = target.RetrieveVersion();

//
 // Assert
 //
 Assert.AreEqual(callCount, 1); // verify OrganizationServiceContext.RetrieveVersion is called once

Assert.AreEqual(expected, actual);
 }

}

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

In a previous post (Part 3: Microsoft Fakes with OrganizationServiceContext), I have describe how to use run time redirect delegate feature of Microsoft Fakes to unit test OrganizationServiceContext. I consider this a direct approach since you do not need to understand the IOrganizationService API and you do not need to know all the underlining messages. If you know IOrganizationService API and underlining messages, there is also an indirect approach to unit test OrganizationServiceContext, which is to mock the underlining IOrganizationService.

We need to provide an instance of IOrganizationService to construct OrganizationServiceContext, if we mock IOrganizationService properly, we can isolate OrganizationServiceContext unit test.

Code under test

public class ContextMethods2
 {
 private OrganizationServiceContext _context;

public ContextMethods2(IOrganizationService service)
 {
 _context = new OrganizationServiceContext(service);
 }

public Guid CreateAccount(string name)
 {
 var entity = new Entity("account")
 {
 Attributes = new Microsoft.Xrm.Sdk.AttributeCollection
 {
 { "name", name }
 }
 };

_context.AddObject(entity);

var results = _context.SaveChanges();

return entity.Id;
 }
 }

Unit Test

[TestClass]
 public class ContextMethods2Test
 {
 [TestMethod]
 public void CreateAccountTest()
 {
 //
 // Arrange
 //
 string accountName = "abcabcabc";
 Guid actual;
 Guid expected = Guid.Empty;

int callCount = 0;
 Entity entity = null;

var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();
 service.ExecuteOrganizationRequest = r =>
 {
 callCount++;

var request = r as CreateRequest;
 entity = request.Target;
 expected = entity.Id;

return new CreateResponse
 {
 Results = new ParameterCollection
 {
 { "id", expected }
 }
 };
 };

ContextMethods2 target = new ContextMethods2(service);

//
 // Act
 //
 actual = target.CreateAccount(accountName);

//
 // Assert
 //
 Assert.AreEqual(callCount, 1); // verify OrganizationServiceContext.AddObject is called once
 Assert.IsNotNull(entity); // verify OrganizationServiceContext.AddObject is called with not null object
 Assert.AreEqual(entity.LogicalName, "account"); // verify OrganizationServiceContext.AddObject is called with entity with proper entity name
 Assert.AreEqual(entity.GetAttributeValue<string>("name"), accountName); // verify OrganizationServiceContext.AddObject is called with entity with proper value set on name attribute

Assert.AreEqual(expected, actual);
 }
 }

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

In a previous post (Part 2: Microsoft Fakes with LINQ query), I have describe how to use run time redirect delegate feature of Microsoft Fakes to unit test LINQ to CRM query. I consider this a direct approach since you do not need to understand the IOrganizationService API and you do not need to know all the underlining messages. If you know IOrganizationService API and underlining messages, there is also an indirect approach to unit test LINQ to CRM query, which is to mock the underlining IOrganizationService.

To use LINQ to query CRM data, we need to use OrganizationServiceContext or a deriving class such as CrmOrganizationServiceContext which is SDK Extensions contained in Microsoft.Xrm.Client assembly, or a deriving class created by the CrmSvcUtil tool. The OrganizationServiceContext class contains an underlying LINQ query provider that translates LINQ queries from Microsoft Visual C# or Microsoft Visual Basic .NET syntax into the query API used by Microsoft Dynamics CRM.

We need to provide an instance of IOrganizationService to construct OrganizationServiceContext, OrganizationServiceContext is going to translate LINQ to CRM query into RetrieveMultipleRequest and execute that OrganizationRequest by calling IOrganizationService.Execute. If we mock IOrganizationService properly, we can isolate LINQ to CRM query unit test.

Code under test

public class LINQToCRM2
 {
 private OrganizationServiceContext _context;

public LINQToCRM2(IOrganizationService service)
 {
 _context = new OrganizationServiceContext(service);
 }

public IEnumerable<Entity> RetrieveAccountsByName(string name)
 {
 var query = from account in _context.CreateQuery("account")
 where account.GetAttributeValue<string>("name") == name
 select account;

var accountList = new List<Entity>();

foreach (var entity in query)
 {
 accountList.Add(entity);
 }

//We can simply call query.ToList()
 //foreach loop here is to demonstrate item Enumeration

return accountList;
 }

public Entity RetrieveAccountsById(Guid id)
 {
 var query = from account in _context.CreateQuery("account")
 where account.GetAttributeValue<Guid>("accountid") == id
 select account;

var accountEntity = query.FirstOrDefault();

return accountEntity;
 }
 }

Unit Test

[TestClass]
 public class LINQToCRM2Test
 {
 [TestMethod]
 public void RetrieveAccountsByNameTest()
 {
 //
 // Arrange
 //
 var entity1 = new Microsoft.Xrm.Sdk.Entity("account");
 entity1.Id = Guid.NewGuid();
 entity1["name"] = "abcabcabc";

var entity2 = new Microsoft.Xrm.Sdk.Entity("account");
 entity2.Id = Guid.NewGuid();
 entity2["name"] = "123123123";

var entity3 = new Microsoft.Xrm.Sdk.Entity("account");
 entity3.Id = Guid.NewGuid();
 entity3["name"] = "a1b2c3a1b2c3";

var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();

service.ExecuteOrganizationRequest = r =>
 {
 List<Entity> entities = new List<Entity>
 {
 entity1, entity2
 };

var response = new RetrieveMultipleResponse
 {
 Results = new ParameterCollection
 {
 { "EntityCollection", new EntityCollection(entities) }
 }
 };

return response;
 };

string accountName = "abcabcabc";
 IEnumerable<Microsoft.Xrm.Sdk.Entity> actual;
 LINQToCRM2 target = new LINQToCRM2(service);

//
 // Act
 //
 actual = target.RetrieveAccountsByName(accountName);

//
 // Assert
 //
 Assert.AreEqual(2, actual.Count());
 Assert.AreEqual(entity1, actual.ElementAt(0));
 Assert.AreEqual(entity2, actual.ElementAt(1));
 }

[TestMethod]
 public void RetrieveAccountsByIdTest()
 {
 //
 // Arrange
 //
 Guid id = Guid.NewGuid();

Microsoft.Xrm.Sdk.Entity expected = new Microsoft.Xrm.Sdk.Entity { Id = id };

var service = new Microsoft.Xrm.Sdk.Fakes.StubIOrganizationService();

service.ExecuteOrganizationRequest = r =>
 {
 List<Entity> entities = new List<Entity>
 {
 expected
 };

var response = new RetrieveMultipleResponse
 {
 Results = new ParameterCollection
 {
 { "EntityCollection", new EntityCollection(entities) }
 }
 };

return response;
 };

Microsoft.Xrm.Sdk.Entity actual;
 LINQToCRM2 target = new LINQToCRM2(service);

//
 // Act
 //
 actual = target.RetrieveAccountsById(id);

//
 // Assert
 //
 Assert.AreEqual(expected, actual);
 }
 }

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

If you know IOrganizationService API and underlining messages, there is also an indirect approach to unit test CrmOrganizationServiceContext, which is to mock the underlining IOrganizationService. That is discussed in another post (Part 7: Microsoft Fakes with CrmOrganizationServiceContext through IOrganizationService).

CrmOrganizationServiceContext

CrmOrganizationServiceContext is SDK Extensions contained in Microsoft.Xrm.Client assembly. CrmOrganizationServiceContext allows the entity objects produced by the data context to participate in the WCF Data Services framework. CrmOrganizationServiceContext provide methods from various OrganizationRequest, which means a method based implementation of the message API. These methods are defined as extension methods, to use these methods we have to include the Microsoft.Xrm.Client.Messages namespace.

For more information on CrmOrganizationServiceContext, see Developer Extensions Context Object Model

Microsoft Fakes does not support CrmOrganizationServiceContext, if we try to set up a run time delegate, we will receive ShimNotSupported exception. So we can go the traditional way to extract interface and provide a wrap type around CrmOrganizationServiceContext and implement that interface.

Most of the methods contained within SDK extension are OrganizationServiceContext extension methods. These methods are defined in Microsoft.Xrm.Client.Messages.OrganizationServiceContextExtensions and Microsoft.Xrm.Client.OrganizationServiceContextExtensions. And I have created one Interface and a wrapper Class.

https://gist.github.com/3180585

https://gist.github.com/3180591

namespace CrmOrganizationServiceContextExtensions
{
 public interface ICrmOrganizationServiceContext
 {
 /*
 * Microsoft.Xrm.Client.Messages.OrganizationServiceContextExtensions
 */

/*
 * Microsoft.Xrm.Client.CrmOrganizationServiceContext
 */
 }
}

namespace CrmOrganizationServiceContextExtensions
{
 public class CrmContext : CrmOrganizationServiceContext, ICrmOrganizationServiceContext
 {
 public CrmContext() : base() { }
 public CrmContext(string contextName) : base(contextName) { }
 public CrmContext(CrmConnection connection) : base(connection) { }
 public CrmContext(IOrganizationService service) : base(service) { }

private Microsoft.Xrm.Sdk.Client.OrganizationServiceContext _context;
 private Microsoft.Xrm.Sdk.Client.OrganizationServiceContext Context
 {
 get
 {
 if (_context == null)
 {
 _context = this as Microsoft.Xrm.Sdk.Client.OrganizationServiceContext;
 }

return _context;
 }
 }

/*
 * Microsoft.Xrm.Client.Messages.OrganizationServiceContextExtensions
 */

/*
 * Microsoft.Xrm.Client.OrganizationServiceContextExtensions
 */
 }
}

We can start using the Interface and wrapper Class in our code.

Suppose we have the following code under test

public class CrmContextMethods
 {
 private ICrmOrganizationServiceContext _crmContext;

public CrmContextMethods(ICrmOrganizationServiceContext crmContext)
 {
 _crmContext = crmContext;
 }

public string RetrieveVersion()
 {
 var version = _crmContext.RetrieveVersion();

return version;
 }

public Guid CreateAccount(string name)
 {
 var entity = new Entity("account")
 {
 Attributes = new Microsoft.Xrm.Sdk.AttributeCollection
 {
 { "name", name }
 }
 };

var id = _crmContext.Create(entity);

return id;
 }
 }

The unit test code code could be

[TestClass]
 public class CrmContextMethodsTest
 {
 [TestMethod]
 public void CreateAccountTest()
 {
 //
 // Arrange
 //
 string accountName = "abcabcabc";
 Guid actual;
 Guid expected = Guid.NewGuid();

int callCount = 0;
 Entity entity = null;

var context = new CrmOrganizationServiceContextExtensions.Fakes.StubICrmOrganizationServiceContext();
 context.CreateEntity = e =>
 {
 callCount++;
 entity = e;
 return expected;
 };

CrmContextMethods target = new CrmContextMethods(context);

//
 // Act
 //
 actual = target.CreateAccount(accountName);

//
 // Assert
 //
 Assert.AreEqual(callCount, 1); // verify OrganizationServiceContext.Create is called once
 Assert.IsNotNull(entity); // verify OrganizationServiceContext.Create is called with not null object
 Assert.AreEqual(entity.LogicalName, "account"); // verify OrganizationServiceContext.Create is called with entity with proper entity name
 Assert.AreEqual(entity.GetAttributeValue<string>("name"), accountName); // verify OrganizationServiceContext.Create is called with entity with proper value set on name attribute

Assert.AreEqual(expected, actual);

}

[TestMethod]
 public void RetrieveVersionTest()
 {
 //
 // Arrange
 //
 string actual;
 string expected = "5.0.9690.2243";

int callCount = 0;

var context = new CrmOrganizationServiceContextExtensions.Fakes.StubICrmOrganizationServiceContext();
 context.RetrieveVersion = () =>
 {
 callCount++;
 return expected;
 };

CrmContextMethods target = new CrmContextMethods(context);

//
 // Act
 //
 actual = target.RetrieveVersion();

//
 // Assert
 //
 Assert.AreEqual(callCount, 1); // verify OrganizationServiceContext.RetrieveVersion is called once

Assert.AreEqual(expected, actual);

}
 }

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

If you know IOrganizationService API and underlining messages, there is also an indirect approach to unit test OrganizationServiceContext, which is to mock the underlining IOrganizationService. That is discussed in another post (Dynamics CRM 2011 Unit Test Part 6: Microsoft Fakes with OrganizationServiceContext through IOrganizationService).

OrganizationServiceContext

OrganizationServiceContext is based on the same concept as the ObjectContext Class in Entity Framework. The OrganizationServiceContext class lets you track changes, manage identities and relationships. Objects tracked by the organization service context are instances of entity types that represent data in Microsoft Dynamics CRM. You can designate actions to be performed on these objects and the service context tracks the changes. When the SaveChanges method is called, the service context instructs Microsoft Dynamics CRM to generate commands to create, update or delete the entities the tracked objects represent.

For more information on OrganizationServiceContext, see Use the Organization Service Context Class and OrganizationServiceContext Class

The main method that we want to simulate is OrganizationServiceContext.SaveChanges(). We will need to create fakes assembly for microsoft.xrm.sdk assembly using visual studio 2012, after that we can use Microsoft.Xrm.Sdk.Client.Fakes.ShimOrganizationServiceContext type contained within the fake assembly to detour call to OrganizationServiceContext.SaveChanges().

var fakeContext = new Microsoft.Xrm.Sdk.Client.Fakes.ShimOrganizationServiceContext(context);
fakeContext.SaveChanges = () =>
 {
 entity.Id = expected;

 // SaveChangesResultCollection only has one internal constructor
 // so we can not create a instance outside of Microsoft.Xrm.Sdk assembly
 // we will use reflection to create instances of SaveChangesResultCollection and SaveChangesResult
 var results = CreateSaveChangesResultCollection(SaveChangesOptions.None);

var request = new OrganizationRequest();
 var response = new OrganizationResponse();

results.Add(CreateSaveChangesResult(request, response));

return results;
 };

It should be very straightforward, except that SaveChangesResult and SaveChangesResultCollection only have internal constructors, we have to use reflection to create  SaveChangesResult and SaveChangesResultCollection that returned from OrganizationServiceContext.SaveChanges().

Create SaveChangesResultCollection

private SaveChangesResultCollection CreateSaveChangesResultCollection(SaveChangesOptions option)
 {
 var con = typeof(SaveChangesResultCollection).GetConstructors(BindingFlags.NonPublic | BindingFlags.Instance).FirstOrDefault();
 var results = con.Invoke(new object[] { option }) as SaveChangesResultCollection;
 return results;
 }

Create SaveChangesResult

private SaveChangesResult CreateSaveChangesResult(OrganizationRequest request, OrganizationResponse response)
 {
 var con = typeof(SaveChangesResult).GetConstructors(BindingFlags.NonPublic | BindingFlags.Instance).FirstOrDefault();
 var result = con.Invoke(new object[] { request, response }) as SaveChangesResult;
 return result;
 }

private SaveChangesResult CreateSaveChangesResult(OrganizationRequest request, Exception error)
 {
 var con = typeof(SaveChangesResult).GetConstructors(BindingFlags.NonPublic | BindingFlags.Instance).FirstOrDefault();
 var result = con.Invoke(new object[] { request, error }) as SaveChangesResult;
 return result;
 }

Suppose we use the following code to create account in crm

public class ContextMethods
 {
 private OrganizationServiceContext _context;

public ContextMethods(OrganizationServiceContext context)
 {
 _context = context;
 }

public Guid CreateAccount(string name)
 {
 var entity = new Entity("account")
 {
 Attributes = new Microsoft.Xrm.Sdk.AttributeCollection
 {
 { "name", name }
 }
 };

_context.AddObject(entity);

var results = _context.SaveChanges();

return entity.Id;
 }
 }

The unit test code could be

[TestClass]
 public class ContextMethodsTest
 {
 [TestMethod]
 public void CreateAccountTest()
 {
 //
 // Arrange
 //
 var connection = new CrmConnection("Crm");
 var service = new OrganizationService(connection);
 var context = new OrganizationServiceContext(service);
 using (ShimsContext.Create())
 {
 string accountName = "abcabcabc";
 Guid actual;
 Guid expected = Guid.NewGuid();

int callCount = 0;
 Entity entity = null;

var fakeContext = new Microsoft.Xrm.Sdk.Client.Fakes.ShimOrganizationServiceContext(context);

fakeContext.AddObjectEntity = e =>
 {
 callCount++;
 entity = e;
 };

fakeContext.SaveChanges = () =>
 {
 entity.Id = expected;

 // SaveChangesResultCollection only has one internal constructor
 // so we can not create a instance outside of Microsoft.Xrm.Sdk assembly
 // we will use reflection to create instances of SaveChangesResultCollection and SaveChangesResult
 var results = CreateSaveChangesResultCollection(SaveChangesOptions.None);

var request = new OrganizationRequest();
 var response = new OrganizationResponse();

results.Add(CreateSaveChangesResult(request, response));

return results;
 };

ContextMethods target = new ContextMethods(context);

//
 // Act
 //
 actual = target.CreateAccount(accountName);

//
 // Assert
 //
 Assert.AreEqual(callCount, 1); // verify OrganizationServiceContext.AddObject is called once
 Assert.IsNotNull(entity); // verify OrganizationServiceContext.AddObject is called with not null object
 Assert.AreEqual(entity.LogicalName, "account"); // verify OrganizationServiceContext.AddObject is called with entity with proper entity name
 Assert.AreEqual(entity.GetAttributeValue<string>("name"), accountName); // verify OrganizationServiceContext.AddObject is called with entity with proper value set on name attribute

 Assert.AreEqual(expected, actual);
 }
 }

private SaveChangesResultCollection CreateSaveChangesResultCollection(SaveChangesOptions option)
 {
 var con = typeof(SaveChangesResultCollection).GetConstructors(BindingFlags.NonPublic | BindingFlags.Instance).FirstOrDefault();
 var results = con.Invoke(new object[] { option }) as SaveChangesResultCollection;
 return results;
 }

private SaveChangesResult CreateSaveChangesResult(OrganizationRequest request, OrganizationResponse response)
 {
 var con = typeof(SaveChangesResult).GetConstructors(BindingFlags.NonPublic | BindingFlags.Instance).FirstOrDefault();
 var result = con.Invoke(new object[] { request, response }) as SaveChangesResult;
 return result;
 }

private SaveChangesResult CreateSaveChangesResult(OrganizationRequest request, Exception error)
 {
 var con = typeof(SaveChangesResult).GetConstructors(BindingFlags.NonPublic | BindingFlags.Instance).FirstOrDefault();
 var result = con.Invoke(new object[] { request, error }) as SaveChangesResult;
 return result;
 }
 }

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

If you know IOrganizationService API and underlining messages, there is also an indirect approach to unit test LINQ to CRM query, which is to mock the underlining IOrganizationService. That is discussed in another post (Dynamics CRM 2011 Unit Test Part 5: Microsoft Fakes with LINQ query through IOrganizationService).

LINQ to CRM query

Dynamics CRM 2011 supports using LINQ to query CRM data, which makes the query much more easy to write and compact. We do not need to construct a complex QueryExpression object for simple queries.

To use LINQ to query CRM data, we need to use OrganizationServiceContext or a deriving class such as CrmOrganizationServiceContext which is SDK Extensions contained in Microsoft.Xrm.Client assembly, or a deriving class created by the CrmSvcUtil tool. The OrganizationServiceContext class contains an underlying LINQ query provider that translates LINQ queries from Microsoft Visual C# or Microsoft Visual Basic .NET syntax into the query API used by Microsoft Dynamics CRM.

For more information on Build Queries with LINQ, please see Build Queries with LINQ (.NET Language-Integrated Query)

When test LINQ to CRM query, there are some challengers. First OrganizationServiceContext does not implement any interface or abstract class, second LINQ to CRM query involved some method in System.Linq namespace.

public class OrganizationServiceContext : IDisposable
public class CrmOrganizationServiceContext : OrganizationServiceContext, IInitializable, IOrganizationService, IUpdatable, IExpandProvider, IOrganizationServiceContainer
public partial class ServiceContext: Microsoft.Xrm.Sdk.Client.OrganizationServiceContext

The common method to test such class is to abstract an interface and use that interface in the calling code, but this method need to write more code and carefully design of the code. (This will be discussed in later posts with Rhino Mocks and Moq). A better approach is to use either Microsoft Fakes test framework or Microsoft Moles test framework. We will focus on Microsoft Fakes test framework in this post, Microsoft Moles will be introduced in later post.

Microsoft Fakes test framework is included in Visual Studio 2012 and can generate fakes assembly which contains shim types.  Shim types allow detouring of hard-coded dependencies on static or non-overridable methods.

For more information on Microsoft Fakes, please see Isolating Unit Test Methods with Microsoft Fakes

Let’s see a few unit test sample which use Microsoft Fakes

This sample use SDK Extensions contained in Microsoft.Xrm.Client assembly. For more information on Dynamics CRM SDK Extensions, please see SDK Extensions for Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online

We need to generate fake assembly for microsoft.xrm.sdk.dll and System.Core.dll

Enumeration

Suppose we have the following class

public class LINQToCRM
 {
 private OrganizationServiceContext _context;

public LINQToCRM(OrganizationServiceContext context)
 {
 _context = context;
 }

public IEnumerable RetrieveAccountsByName(string name)
 {
 var query = from account in _context.CreateQuery("account")
 where account.GetAttributeValue("name") == name
 select account;

var accountList = new List();

foreach(var entity in query)
 {
 accountList.Add(entity);
 }

//We can simply call query.ToList()
 //foreach loop here is to demonstrate item Enumeration

return accountList;
 }
}

There are two external dependencies in this code fragment. First is OrganizationServiceContext.CreateQuery, Second is foreach(var entity in query).

In this case we have to detour OrganizationServiceContext.CreateQuery and System.Linq.EnumerableQuery<Microsoft.Xrm.Sdk.Entity>.GetEnumerator to user defined delegate.

OrganizationServiceContext.CreateQuery is the place we can simulate Dynamics CRM data store. Entities returned from this method should be considered to be retrieved from Dynamics CRM, and the result will be further filtered by the rest of the LINQ operators.

System.Linq.EnumerableQuery<Microsoft.Xrm.Sdk.Entity>.GetEnumerator is the place we return the final result for the query, regardless of the data store or any LINQ operator.

[TestMethod]
 public void RetrieveAccountsByNameTest()
 {
 var connection = new CrmConnection("Crm");
 var service = new OrganizationService(connection);
 var context = new OrganizationServiceContext(service);
 using (ShimsContext.Create())
 {
 var fakeContext = new Microsoft.Xrm.Sdk.Client.Fakes.ShimOrganizationServiceContext(context);
 LINQToCRM target = new LINQToCRM(context);

var entity1 = new Microsoft.Xrm.Sdk.Entity("account");
 entity1.Id = Guid.NewGuid();
 entity1["name"] = "abcabcabc";

var entity2 = new Microsoft.Xrm.Sdk.Entity("account");
 entity2.Id = Guid.NewGuid();
 entity2["name"] = "123123123";

var entity3 = new Microsoft.Xrm.Sdk.Entity("account");
 entity3.Id = Guid.NewGuid();
 entity3["name"] = "a1b2c3a1b2c3";

fakeContext.CreateQueryString = (entityName) =>
 {
 return new System.Linq.EnumerableQuery(new Microsoft.Xrm.Sdk.Entity[] { entity1, entity2, entity3 });
 };

IEnumerable expected = new List { entity1, entity2 };

System.Linq.Fakes.ShimEnumerableQuery.AllInstances.GetEnumerator = (a) =>
 {
 return expected.GetEnumerator();
 };

string accountName = "abcabcabc";
 IEnumerable actual;
 actual = target.RetrieveAccountsByName(accountName);

Assert.AreEqual(expected.Count(), actual.Count());
 Assert.AreEqual(expected.ElementAt(0), actual.ElementAt(0));
 Assert.AreEqual(expected.ElementAt(1), actual.ElementAt(1));
 }
 }

FirstOrDefault method

If we do not need to enumerate the result but want to call FirstOrDefault method, we can detour System.Linq.Queryable.FirstOrDefault<Microsoft.Xrm.Sdk.Entity> to user defined delegate.

Suppose we have the following code under test

public class LINQToCRM
 {
 private OrganizationServiceContext _context;

public LINQToCRM(OrganizationServiceContext context)
 {
 _context = context;
 }

public Entity RetrieveAccountsById(Guid id)

{
 var query = from account in _context.CreateQuery("account")
 where account.GetAttributeValue("accountid") == id
 select account;

var accountEntity = query.FirstOrDefault();

return accountEntity;
 }
 }

The unit test would be similar to the following

[TestMethod]
 public void RetrieveAccountsByIdTest()
 {
 var connection = new CrmConnection("Crm");
 var service = new OrganizationService(connection);
 var context = new OrganizationServiceContext(service);
 using (ShimsContext.Create())
 {
 var fakeContext = new Microsoft.Xrm.Sdk.Client.Fakes.ShimOrganizationServiceContext(context);
 LINQToCRM target = new LINQToCRM(context);

fakeContext.CreateQueryString = (entityName) =>
 {
 return new System.Linq.EnumerableQuery(new Microsoft.Xrm.Sdk.Entity[] { });
 };

Guid id = Guid.NewGuid();

Microsoft.Xrm.Sdk.Entity expected = new Microsoft.Xrm.Sdk.Entity();

System.Linq.Fakes.ShimQueryable.FirstOrDefaultOf1IQueryableOfM0((a) =>
 {
 expected.Id = id;
 return expected;
 });

Microsoft.Xrm.Sdk.Entity actual;

actual = target.RetrieveAccountsById(id);

Assert.AreEqual(expected, actual);
 }
 }

Other common LINQ methods

Other common LINQ methods could also be find in System.Linq.Queryable class, so that we can use the generated shim class System.Linq.Fakes.ShimQueryable to detour required methods call to user defined delegate.

Note: Not all the methods are supported by Dynamics CRM. (e.g. Any is not supported)

This is the first post of a series containing collections of patterns and code fragments showing how various unit frameworks can be used in Dynamics CRM 2011 development.

Unit test with server side components, (web service, plugin, workflow), will be explained with Microsoft Fakes, Rhino Mocks and Moq.

Unit test with client side JavaScript will be explained with QUnit.

The complete sample code using Microsoft Fakes can be downloaded from MSDN sample gallery: Dynamics CRM unit test using Microsoft Fakes

Series Contents

Part 1: Introduction and Series Contents

• Introduces the topics that will be covered in the series

Part 2: Microsoft Fakes with LINQ query

• Unit test CRM LINQ query
• Mock System.Linq namespace
• Mock Mock OrganizationServiceContext.CreateQuery

Part 4: Microsoft Fakes with CrmOrganizationServiceContext

• Mock CrmOrganizationServiceContext

Part 5: Microsoft Fakes with LINQ query through IOrganizationService

• Mock IOrganizationService to isolate LINQ to CRM query

Part 6: Microsoft Fakes with OrganizationServiceContext through IOrganizationService

• Isolate method call to OrganizationServiceContext through mocking IOrganizationService

Part 7: Microsoft Fakes with CrmOrganizationServiceContext through IOrganizationService

• Isolate method call to OrganizationServiceContext extension methods through mocking IOrganizationService
• Isolate method call to CrmOrganizationServiceContext through mocking IOrganizationService

Part 8: Microsoft Fakes with IOrganizationService

• Using Stub type to isolate method call to IOrganizationService

Part 9: Microsoft Fakes with CRM plugin

•  Mock IOrganizationService, IPluginExecutionContext, ITracingService, IOrganizationServiceFactory and IServiceProvider

Part 10: Microsoft Fakes with workflow activity

• Correctly invoke CodeActivity.Execute(CodeActivityContext executionContext)
• Correctly pass in InArgument<T> properties
• Pass in required service as extensions

Part 11: QUnit with client side JavaScript

• QUnit
• Xrm.Page Script Library Template (Microsoft Visual Studio extension)

Part 12: Rhino Mocks with LINQ query, OrganizationServiceContext and CrmOrganizationServiceContext

Part 13: Rhino Mocks with IOrganizationService

Part 14: Rhino Mocks with CRM plugin

Part 15: Rhino Mocks with workflow activity

Part 16: Moq with LINQ query, OrganizationServiceContext and CrmOrganizationServiceContext

Part 17: Moq with IOrganizationService

Part 18: Moq with CRM plugin

Part 19: Moq with workflow activity

The out of the box workflow create user interface only provide access to current value of the record which is the value after modification.

We could write one custom workflow activity to retrieve that value from IExecutionContext, which can be accessed from IWorkflowContext within custom workflow activity.

protected override void Execute(CodeActivityContext executionContext)
 {
IWorkflowContext context = executionContext.GetExtension<IWorkflowContext>();
Entity preImageEntity = context.PreEntityImages.Values.FirstOrDefault();
}

When use InOutArgument<EntityReference > in custom workflow activity, we need to specify the entity name which made it difficult to reuse, instead we could accept the attribute name of the lookup field and output entity name and record id for that lookup field. We can use entity name and record id in other workflow activity to perform generic tasks.

Here is a sample code to retrieve record id and entity name from custom workflow activity

public sealed class GetRecordIdEntityName : CodeActivity
 {
 [Input("Attribute Name for Related Record")]
 public InArgument<String> AttributeName { get; set; }

[Output("Primary Entity Name")]
 public OutArgument<String> PrimaryEntityName { get; set; }

[Output("Primary Record Id")]
 public OutArgument<String> PrimaryRecordId { get; set; }

[Output("Related Entity Name")]
 public OutArgument<String> RelatedEntityName { get; set; }

[Output("Pre Related Record Id")]
 public OutArgument<String> PreRelatedRecordId { get; set; }

[Output("Post Related Record Id")]
 public OutArgument<String> PostRelatedRecordId { get; set; }

/// <summary>
 /// Executes the workflow activity.
 /// </summary>
 /// <param name="executionContext">The execution context.</param>
 protected override void Execute(CodeActivityContext executionContext)
 {
 // Create the tracing service
 ITracingService tracingService = executionContext.GetExtension<ITracingService>();

if (tracingService == null)
 {
 throw new InvalidPluginExecutionException("Failed to retrieve tracing service.");
 }

tracingService.Trace("Entered GetRecordId.Execute(), Activity Instance Id: {0}, Workflow Instance Id: {1}",
 executionContext.ActivityInstanceId,
 executionContext.WorkflowInstanceId);

// Create the context
 IWorkflowContext context = executionContext.GetExtension<IWorkflowContext>();

if (context == null)
 {
 throw new InvalidPluginExecutionException("Failed to retrieve workflow context.");
 }

tracingService.Trace("GetRecordId.Execute(), Correlation Id: {0}, Initiating User: {1}",
 context.CorrelationId,
 context.InitiatingUserId);

IOrganizationServiceFactory serviceFactory = executionContext.GetExtension<IOrganizationServiceFactory>();
 IOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);

try
 {
 // TODO: Implement your custom Workflow business logic.
 ExecuteCore(executionContext, context, service);
 }
 catch (FaultException<OrganizationServiceFault> e)
 {
 tracingService.Trace("Exception: {0}", e.ToString());

// Handle the exception.
 throw;
 }

tracingService.Trace("Exiting GetRecordId.Execute(), Correlation Id: {0}", context.CorrelationId);
 }

private void ExecuteCore(CodeActivityContext executionContext, IWorkflowContext context, IOrganizationService service)
 {
 this.PrimaryRecordId.Set(executionContext, context.PrimaryEntityId.ToString());

this.PrimaryEntityName.Set(executionContext, context.PrimaryEntityName.ToLowerInvariant());

string attributeName = this.AttributeName.Get(executionContext);

this.RelatedEntityName.Set(executionContext, null);

if (!string.IsNullOrWhiteSpace(attributeName))
 {
 Entity preImageEntity = context.PreEntityImages.Values.FirstOrDefault();
 if (preImageEntity != null && preImageEntity.Contains(attributeName) && preImageEntity[attributeName] is EntityReference)
 {
 EntityReference entityRef = preImageEntity.GetAttributeValue<EntityReference>(attributeName);
 this.RelatedEntityName.Set(executionContext, entityRef.LogicalName.ToLowerInvariant());
 this.PreRelatedRecordId.Set(executionContext, entityRef.Id.ToString());
 }
 else
 {
 this.PreRelatedRecordId.Set(executionContext, null);
 }

Entity postImageEntity = context.PostEntityImages.Values.FirstOrDefault();
 if (postImageEntity != null && postImageEntity.Contains(attributeName) && postImageEntity[attributeName] is EntityReference)
 {
 EntityReference entityRef = postImageEntity.GetAttributeValue<EntityReference>(attributeName);
 this.RelatedEntityName.Set(executionContext, entityRef.LogicalName.ToLowerInvariant());
 this.PostRelatedRecordId.Set(executionContext, entityRef.Id.ToString());
 }
 else
 {
 this.PostRelatedRecordId.Set(executionContext, null);
 }
 }
 else
 {
 this.PreRelatedRecordId.Set(executionContext, null);
 this.PostRelatedRecordId.Set(executionContext, null);
 }
 }
 }

This kind of view is supported but can not be achieved through customization user interface.

System view and user view are defined by using fetchxml and layoutxml, we could create a view through CRM API and set the correct fetchxml with is not support in out of the box customization user interface.

When records are shared, CRM create a record of “principalobjectaccess” entity; so we can link the entity we want to display to this entity to construct proper fetchxml.

The drawback of the approach is that you can not use customization user interface to modify the column layout and sort order.

Suppose we have an entity called “zzhou_cfiapplication” and we want to create a view to display records shared with current user.

The important piece of xml to add to view fetchxml is the link entity to “principalobjectaccesss” entity.

<link-entity name='principalobjectaccess' to='zzhou_cfiapplicationid' from='objectid' link-type='inner' alias='share'>
 <filter type='and'>
 <condition attribute='principalid' operator='eq-userid' />
 </filter>
</link-entity>

It is much more easier to configure the view in customization user interface to set up correct columns and sort order, and then modify the fetchxml for that view.

We can use the following code to retrieve the view that we want to modify

public Entity RetrieveSavedQuery(OrganizationServiceContext context, Guid queryId)
 {
 var query = from q in context.CreateQuery("savedquery")
 where q.GetAttributeValue<Guid>("savedqueryid") == queryId
 select q;

Entity record = query.FirstOrDefault();

return record;
 }

we can update the view by using the following code

</pre>
public void UpdateSavedQuery(IOrganizationService service)
 {
 Entity savedQuery = new Entity("savedquery");
 savedQuery.Id = new Guid("00bc926f-26c0-e111-a4f9-00155d4c5b01");
 savedQuery["fetchxml"] = @"<fetch version='1.0' output-format='xml-platform' mapping='logical' distinct='false'>
 <entity name='zzhou_cfiapplication'>
 <attribute name='zzhou_name' />
 <attribute name='createdon' />
 <order attribute='zzhou_name' descending='false' />
 <link-entity name='principalobjectaccess' to='zzhou_cfiapplicationid' from='objectid' link-type='inner' alias='share'>
 <filter type='and'>
 <condition attribute='principalid' operator='eq-userid' />
 </filter>
 </link-entity>
 <attribute name='zzhou_cfiapplicationid' />
 </entity>
 </fetch>";

service.Update(savedQuery);
 }
<pre>

This post describe how to use late bound entities to create a custom workflow activity to share secured fields, the complete code is in the end of this post.

 Note: If users’ security role says they cannot update records, then they will not be able to update any field on that record even if there is a field level security profile says that they can update that field on that entity.

Each time when users share a secured field to other users, CRM create records of entity “principalobjectattributeaccess” with proper value set for ”readaccess”, “updateaccess”, ”attributeid”,”objectid”, and ”principalid” attributes.

To create this entity correctly, we need the id of the attribute metadata, so we can use the following code to retrieve that id based on the attribute name

// Create the request
 RetrieveAttributeRequest attributeRequest = new RetrieveAttributeRequest
 {
 EntityLogicalName = entityName,
 LogicalName = attributeName,
 RetrieveAsIfPublished = true
 };

// Execute the request
 RetrieveAttributeResponse attributeResponse = (RetrieveAttributeResponse)service.Execute(attributeRequest);

CRM does not allow duplicate records for ”principalobjectattributeaccess” entity, so we need to uses some query like below to check whether there is record exists first.

// Create the query for retrieve User Shared Attribute permissions.
 QueryExpression queryPOAA = new QueryExpression("principalobjectattributeaccess");
 queryPOAA.ColumnSet = new ColumnSet(new string[] { "readaccess", "updateaccess" });
 queryPOAA.Criteria.FilterOperator = LogicalOperator.And;
 queryPOAA.Criteria.Conditions.Add(new ConditionExpression("attributeid", ConditionOperator.Equal, metadataId));
 queryPOAA.Criteria.Conditions.Add(new ConditionExpression("objectid", ConditionOperator.Equal, objectId));
 queryPOAA.Criteria.Conditions.Add(new ConditionExpression("principalid", ConditionOperator.Equal, principalId));

// Execute the query.
 EntityCollection responsePOAA = service.RetrieveMultiple(queryPOAA);

We can now create or update the record to share and update secured field.

Here is the complete custom workflow activity

// <copyright file="ShareSecuredField.cs" company="">
// Copyright (c) 2012 All Rights Reserved
// </copyright>
// <author></author>
// <date>6/5/2012 11:41:45 PM</date>
// <summary>Implements the ShareSecuredField Workflow Activity.</summary>
namespace Xrm.Workflow.Activities
{
 using System;
 using System.Activities;
 using System.ServiceModel;
 using Microsoft.Xrm.Sdk;
 using Microsoft.Xrm.Sdk.Workflow;
 using Microsoft.Xrm.Sdk.Messages;
 using Microsoft.Xrm.Sdk.Query;

public sealed class ShareSecuredField : CodeActivity
 {
 [RequiredArgument]
 [Input("Attribute Name")]
 public InArgument<String> AttributeName { get; set; }

[Input("Share With User")]
 [ReferenceTarget("systemuser")]
 public InArgument<EntityReference> UserToShare { get; set; }

[Input("Share With Team")]
 [ReferenceTarget("team")]
 public InArgument<EntityReference> TeamToShare { get; set; }

[RequiredArgument]
 [Input("Allow Read")]
 [Default("true")]
 public InArgument<Boolean> AllowRead { get; set; }

[RequiredArgument]
 [Input("Allow Update")]
 [Default("true")]
 public InArgument<Boolean> AllowUpdate { get; set; }

/// <summary>
 /// Executes the workflow activity.
 /// </summary>
 /// <param name="executionContext">The execution context.</param>
 protected override void Execute(CodeActivityContext executionContext)
 {
 // Create the tracing service
 ITracingService tracingService = executionContext.GetExtension<ITracingService>();

if (tracingService == null)
 {
 throw new InvalidPluginExecutionException("Failed to retrieve tracing service.");
 }

tracingService.Trace("Entered ShareSecuredField.Execute(), Activity Instance Id: {0}, Workflow Instance Id: {1}", executionContext.ActivityInstanceId, executionContext.WorkflowInstanceId);

// Create the context
 IWorkflowContext context = executionContext.GetExtension<IWorkflowContext>();

if (context == null)
 {
 throw new InvalidPluginExecutionException("Failed to retrieve workflow context.");
 }

tracingService.Trace("ShareSecuredField.Execute(), Correlation Id: {0}, Initiating User: {1}", context.CorrelationId, context.InitiatingUserId);

IOrganizationServiceFactory serviceFactory = executionContext.GetExtension<IOrganizationServiceFactory>();
 IOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);

try
 {
 // TODO: Implement your custom Workflow business logic.
 ExecuteCore(executionContext, context, service);
 }
 catch (FaultException<OrganizationServiceFault> e)
 {
 tracingService.Trace("Exception: {0}", e.ToString());

// Handle the exception.
 throw;
 }

tracingService.Trace("Exiting ShareSecuredField.Execute(), Correlation Id: {0}", context.CorrelationId);
 }

private void ExecuteCore(CodeActivityContext executionContext, IWorkflowContext context, IOrganizationService service)
 {
 string entityName = context.PrimaryEntityName;
 Guid entityId = context.PrimaryEntityId;
 string attributeName = this.AttributeName.Get(executionContext);
 EntityReference userToShare = this.UserToShare.Get(executionContext);
 EntityReference teamToShare = this.TeamToShare.Get(executionContext);
 bool allowRead = this.AllowRead.Get(executionContext);
 bool allowUpdate = this.AllowUpdate.Get(executionContext);

if (userToShare != null)
 {
 Guid objectId = userToShare.Id;
 ShareSecuredFieldCore(service, entityName, attributeName, entityId, objectId, allowRead, allowUpdate, false);
 }

if (teamToShare != null)
 {
 Guid objectId = teamToShare.Id;
 ShareSecuredFieldCore(service, entityName, attributeName, entityId, objectId, allowRead, allowUpdate);
 }
 }

private void ShareSecuredFieldCore(IOrganizationService service, string entityName, string attributeName, Guid objectId, Guid principalId, bool allowRead, bool allowUpdate, bool shareWithTeam = true)
 {
 // Create the request
 RetrieveAttributeRequest attributeRequest = new RetrieveAttributeRequest
 {
 EntityLogicalName = entityName,
 LogicalName = attributeName,
 RetrieveAsIfPublished = true
 };

// Execute the request
 RetrieveAttributeResponse attributeResponse = (RetrieveAttributeResponse)service.Execute(attributeRequest);

if (attributeResponse.AttributeMetadata != null && attributeResponse.AttributeMetadata.IsSecured != null && attributeResponse.AttributeMetadata.IsSecured.HasValue && attributeResponse.AttributeMetadata.IsSecured.Value)
 {
 // Create the query for retrieve User Shared Attribute permissions.
 QueryExpression queryPOAA = new QueryExpression("principalobjectattributeaccess");
 queryPOAA.ColumnSet = new ColumnSet(new string[] { "readaccess", "updateaccess" });
 queryPOAA.Criteria.FilterOperator = LogicalOperator.And;
 queryPOAA.Criteria.Conditions.Add(new ConditionExpression("attributeid", ConditionOperator.Equal, attributeResponse.AttributeMetadata.MetadataId));
 queryPOAA.Criteria.Conditions.Add(new ConditionExpression("objectid", ConditionOperator.Equal, objectId));
 queryPOAA.Criteria.Conditions.Add(new ConditionExpression("principalid", ConditionOperator.Equal, principalId));

// Execute the query.
 EntityCollection responsePOAA = service.RetrieveMultiple(queryPOAA);

if (responsePOAA.Entities.Count > 0)
 {
 Entity poaa = responsePOAA.Entities[0];

if (allowRead || allowUpdate)
 {
 poaa["readaccess"] = allowRead;
 poaa["updateaccess"] = allowUpdate;

service.Update(poaa);
 }
 else
 {
 service.Delete("principalobjectattributeaccess", poaa.Id);
 }
 }
 else
 {
 if (allowRead || allowUpdate)
 {
 // Create POAA entity for user
 Entity poaa = new Entity("principalobjectattributeaccess");
 poaa["attributeid"] = attributeResponse.AttributeMetadata.MetadataId;
 poaa["objectid"] = new EntityReference(entityName, objectId);
 poaa["readaccess"] = allowRead;
 poaa["updateaccess"] = allowUpdate;
 if (shareWithTeam)
 {
 poaa["principalid"] = new EntityReference("team", principalId);
 }
 else
 {
 poaa["principalid"] = new EntityReference("systemuser", principalId);
 }

service.Create(poaa);
 }
 }
 }
 }
 }
}

There are sample code in the following location in the SDK download:

SampleCode\CS\FieldSecurity\RetrieveUserSharedAttributePermissions.cs

SampleCode\VB\FieldSecurity\RetrieveUserSharedAttributePermissions.vb

The complete source code can be download from sample gallery: Kendo UI DataSource, Kendo UI Grid with Dynamics CRM 2011 REST Endpoint

Kendo UI is a HTML5, jQuery-based framework for building modern HTML apps. Kendo UI combines the best of emerging HTML5, CSS3, and JavaScript technologies with robust, cross-browser techniques to deliver a framework that is both powerfully rich and broadly compatible with older browsers.

Microsoft Dynamics CRM 2011 Release 8 include support for IE, Chrome, Firefox and Safari.

By using a powerful JavaScript framework, the use of ASP.NET is reduced which would remove the complexity of deployment which also makes the solution much more portable.

By using Kendo UI DataSource, Kendo UI Grid with Dynamics CRM 2011 REST Endpoint, it is easy to implement server side filter, sorting and paging.

There are a few tricks to use Kendo UI together with Dynamics CRM 2011 I want to share. The complete code is in the end of this post.

1. Microsoft Dynamics CRM 2011 REST Endpoint does not support $format system query option.

You can use a global jQuery ajax event handler to specifying http header ensures that the results will be returned as JSON.

$(document).ajaxSend(function (e, jqxhr, settings) {
 if (settings.url.toLowerCase().indexOf("XRMServices/2011/OrganizationData.svc".toLowerCase()) >= 0) {
 jqxhr.setRequestHeader("Accept", "application/json");
 }
});

2. Microsoft Dynamics CRM 2011 REST Endpoint does not support $inlinecount, $count system query option.

you can set a function to use fetch xml and soap endpoint to return the total record count.

var dataSource = new kendo.data.DataSource({
 schema: {
 total: function (data) {

var fetchXml = '' +
 '' +
 "" +
 '' +
 '';

var context = GetGlobalContext();

var serverUrl = window.parent.document.location.protocol + '//' + window.parent.document.location.host + '/' + context.getOrgUniqueName();

var _oService = new FetchUtil(context.getOrgUniqueName(), serverUrl);
 var res = _oService.Fetch(fetchXml);

var count = res[0].attributes.count.formattedValue;

return count;
 }
 }
});

3. you need to stop Kendo UI to send default query string parameter and use Dynamics CRM 2011 specific format

var dataSource = new kendo.data.DataSource({
 transport: {
 parameterMap: function (options) {
 return {
 $top: options.take,
 $skip: options.skip,
 $select: 'cgi_name,cgi_postcodeareaId',
 $orderby: options.sort[0].field + ' ' + options.sort[0].dir
 };
 }
 }
});

4. you have to parse returned json object to return object array that Kendo UI understand

var dataSource = new kendo.data.DataSource({
 schema: {
 parse: function (data) {
 return data.d.results;
 },
 type: "json"
 }
});

Complete Kendo UI DataSource code

var dataSource = new kendo.data.DataSource({
    transport: {
        read: {
            url: "http://vmcrm/RECRegistry/XRMServices/2011/OrganizationData.svc/cgi_postcodeareaSet",
            dataType: 'json'
        },
        parameterMap: function (options) {
            return {
                $top: options.take,
                $skip: options.skip,
                $select: 'cgi_name,cgi_postcodeareaId',
                $orderby: options.sort[0].field + ' ' + options.sort[0].dir
            };
        }
    },
    schema: {
        model: {
            id: "cgi_postcodeareaId",
            fields: {
                cgi_name: { type: "string" },
                cgi_postcodeareaId: { type: "string" }
            }
        },
        total: function (data) {

            var fetchXml = '' +
                                           '' +
                                                "" +
                                           '' +
                                       '';

            var context = GetGlobalContext();

            var serverUrl = window.parent.document.location.protocol + '//' + window.parent.document.location.host + '/' + context.getOrgUniqueName();

            var _oService = new FetchUtil(context.getOrgUniqueName(), serverUrl);
            var res = _oService.Fetch(fetchXml);

            var count = res[0].attributes.count.formattedValue;

            return count;
        },
        parse: function (data) {
            return data.d.results;
        },
        type: "json"
    },
    serverPaging: true,
    pageSize: 10,
    serverSorting: true,
    sort: { field: "cgi_name", dir: "asc" }
});

Complete Sample code

    Postcode Areas
<script type="text/javascript" src="../Scripts/jquery.min.js"></script><script type="text/javascript" src="../Scripts/kendo.web.min.js"></script>
<script type="text/javascript" src="../Scripts/FetchUtil.js"></script><script type="text/javascript" src="../../../ClientGlobalContext.js.aspx"></script>
<script type="text/javascript">// <![CDATA[
        var selectedIds = {};

        $(document).ready(function ($) {

            var dataSource = new kendo.data.DataSource({
                transport: {
                    read: {
                        url: "http://vmcrm/RECRegistry/XRMServices/2011/OrganizationData.svc/cgi_postcodeareaSet",
                        dataType: 'json'
                    },
                    parameterMap: function (options) {
                        return {
                            $top: options.take,
                            $skip: options.skip,
                            $select: 'cgi_name,cgi_postcodeareaId',
                            $orderby: options.sort[0].field + ' ' + options.sort[0].dir
                        };
                    }
                },
                schema: {
                    model: {
                        id: "cgi_postcodeareaId",
                        fields: {
                            cgi_name: { type: "string" },
                            cgi_postcodeareaId: { type: "string" }
                        }
                    },
                    total: function (data) {

                        var fetchXml = '<fetch mapping="logical" aggregate="true">' +
                                           '<entity name="cgi_postcodearea">' +
                                                "<attribute name='cgi_postcodeareaid' alias='count' aggregate='count'/>" +
                                           '</entity>' +
                                       '</fetch>';

                        var context = GetGlobalContext();

                        var serverUrl = window.parent.document.location.protocol + '//' + window.parent.document.location.host + '/' + context.getOrgUniqueName();

                        var _oService = new FetchUtil(context.getOrgUniqueName(), serverUrl);
                        var res = _oService.Fetch(fetchXml);

                        var count = res[0].attributes.count.formattedValue;

                        return count;
                    },
                    parse: function (data) {
                        return data.d.results;
                    },
                    type: "json"
                },
                serverPaging: true,
                pageSize: 10,
                serverSorting: true,
                sort: { field: "cgi_name", dir: "asc" }
            });

            var ctlGrid = $("#PostcodeAreaKendoGrid");

            ctlGrid.kendoGrid({
                dataSource: dataSource,
                columns: [{
                    template: '<input type="checkbox" />',
                    sortable: false,
                    width: 9
                },
                {
                    title: 'Postcode Area',
                    field: "cgi_name",
                    width: 120
                }],
                editable: false,
                pageable: true,
                selectable: "multiple, row",
                sortable: {
                    mode: 'single',
                    allowUnsort: false
                },
                dataBound: function () {
                    var grid = this;
                    //handle checkbox change
                    grid.table.find("tr").find("td:first input")
                        .change(function (e) {
                            var checkbox = $(this);
                            var selected = grid.table.find("tr").find("td:first input:checked").closest("tr");

                            grid.clearSelection();

                            //persist selection per page
                            var ids = selectedIds[grid.dataSource.page()] = [];

                            if (selected.length) {
                                grid.select(selected);
                                selected.each(function (idx, item) {
                                    ids.push(grid.dataItem(item).id);
                                });
                            }

                        })
                        .end()
                        .mousedown(function (e) {
                            e.stopPropagation();
                        });

                    //select persisted rows
                    var selected = $();
                    var ids = selectedIds[grid.dataSource.page()] || [];

                    for (var idx = 0, length = ids.length; idx < length; idx++) {
                        var dataItem = grid.dataSource.get(ids[idx]);
                        if (dataItem) {
                            selected = selected.add(grid.table.find("tr[data-uid=" + dataItem.uid + "]"));
                        }
                    }

                    selected
                        .find("td:first input")
                        .attr("checked", true)
                        .trigger("change");

                }
            });

            var grid = ctlGrid.data("kendoGrid");

            grid.thead.find("th:first")
                .append($('<input class="selectAll" type="checkbox"/>'))
                .delegate(".selectAll", "click", function () {
                    var checkbox = $(this);

                    grid.table.find("tr")
                        .find("td:first input")
                        .attr("checked", checkbox.is(":checked"))
                        .trigger("change");
                });
        }).ajaxSend(function (e, jqxhr, settings) {
            if (settings.url.toLowerCase().indexOf("XRMServices/2011/OrganizationData.svc".toLowerCase()) >= 0) {
                jqxhr.setRequestHeader("Accept", "application/json");
            }
        });

// ]]></script></pre>
<div id="PostcodeAreaKendoGrid"></div>
<pre>

When create plug-in using developer toolkit, you need to first select the primary entity for the message. There are 19 messages with no primary entity associated, which are listed below.

To create plug-in using developer toolkit for message with no primary entity associated, you can create a plug-in as normal process and modify the generated .cs code file and the RegisterFile.crmregister file.

1. select any entity and create plug-in in CRM Explorer

2. select any message to use, and configure other setting as you need for the message have no primary entity.

3. modify generated .cs code file, so that the plug-in will be executed

the line number is likely to be line 31, on the top of the generated plug-in .cs code file within the plug-in constructor.

update the message to the one have no primary entity and change the entity name to empty string

base.RegisteredEvents.Add(new Tuple<int, string, string, Action<LocalPluginContext>>(10, "Associate", "", new Action<LocalPluginContext>(ExecutePreValidatePostcodeAssociate)));

4. modify RegisterFile.crmregister file, so that the plug-in can be deployed to the CRM server correctly

find the xml for previously generated plug-in, update the message and change entity name to empty string

<Step CustomConfiguration="" Name="PreValidatePostcodeAssociate" Description="Pre-Validation of Postcode Associate" Id="881876af-8ba0-e111-b344-00155d4c5b01" MessageName="Associate" Mode="Synchronous" PrimaryEntityName="" Rank="1" SecureConfiguration="" Stage="PreOutsideTransaction" SupportedDeployment="Both"

2. Copy compiled plug-in assembly’s symbol file (.pdb) to the server’s <crm-root>\Server\bin\assembly folder and restart Internet Information Services (IIS)

3. If the plugin is a Sandboxed Plug-in, set the following registry key to 1 (DWORD) (Create one if it does not exist); restart “Microsoft Dynamics CRM Sandbox Processing Service“ on the sandbox server

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSCRM\SandboxDebugPlugins

4. Copy Remote Debugger (copy entire folder) from local visual studio install folder to remote server, it is located in

C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\Remote Debugger\x64

5. Run msvsmon.exe you copied from previous step on remote server

6. Configure firewall for remote debugging on remote server

7. Copy remote debugger server name from Tools -> Options -> Server Name

8. Attach to process from local visual studio -> Debug -> Attach to process…

9. Set Transport to Default, set Qualifier to the value copies from step 7, (it might looks similar to this: Domain\Account@CRMServerName), select “Show processes from all users”

10. select the right process to attach depend on plug in

• online: w3wp.exe
• offline: Microsoft.Crm.Application.Hoster.exe
• asynchronous registered plug-ins (or custom workflow assemblies): CrmAsyncService.exe
• sandbox (isolation mode): Microsoft.Crm.Sandbox.WorkerProcess.exe

11. set one or more breakpoints in your plug-in code

12. trigger plugin to run

The system job details might looks like this

If the plugin is synchronous, add “CRMAppPool” Identity account to “Local Administrators Group“, restart IIS.

If the plugin is asynchronous, add “Microsoft Dynamics CRM Asynchronous Processing Service” logon account to “Local Administrators Group“, restart service.

This might also happen when you use user account to run “CRMAppPool” and “Microsoft Dynamics CRM Asynchronous Processing Service” and the password is changed, in that case check the if the password is correct and update the password if necessary.

Use the CrmHyperLink control to create a link to another Web page within your CRM portal. The “URL” is consists of ”partial url property” of “Web Page entity”. The CrmHyperLink control is typically displayed as “text” specified by the “name” property of “Web Page” entity.

Microsoft.Xrm.Portal.Web.UI.WebControls.CrmHyperLink inherent from System.Web.UI.WebControls.HyperLink and expose three extra properties; PortalName, SiteMarkerName and QueryString.

PortalName  is checked against configured portals in the web.config file.

<microsoft.xrm.portal>
 <portals>
 <add name="Customer Portal"/>
 </portals>
</microsoft.xrm.portal>

This value should be the value of Name attribute (adx_name) of Website entity (adx_website) contained in portalbase solution.

Assume we have the following website created in CRM

two portals configured in web.config for each website inside CRM

<microsoft.xrm.portal>
 <portals>
 <add name="Customer Portal"/>
 <add name="Test Portal"/>
 </portals>
</microsoft.xrm.portal>

SiteMarkerName is the value of Name attribute (adx_name) of Site Marker entity (adx_sitemarker) contained in portalbase solution.

QueryString value will be appended to the rendered url as query string.

The Web Page (adx_webpage) entity (related to the Site Marker entity (adx_sitemarker) with the name specified) will be retrieved from CRM first, and the Partial Url (adx_partialurl) attribute value will be used to construct the URL.

Example:

The following markup

<crm:CrmHyperLink ID="CrmHyperLink1" runat="server" SiteMarkerName="KB Article" />

will be rendered as

<a id="Content_CrmHyperLink1" href="/knowledge-base/article">KB Article</a>

This can happen if you rename the database server computer name after you have installed SQL Server.

1. figure out what is saved in SQL Server:

select @@servername

SP_HELPSERVER

2. figure out the database computer name, Start -> Computer -> Properties

3. drop invalid computer name saved in SQL Server

SP_DROPSERVER "INVALID SERVER NAME"

4. add correct computer name to SQL Server

SP_ADDSERVER "CORRECT SERVER NAME", local

5. restart the MSSQLSERVER service

{Record URL(Dynamic)(Entity)}

The value returned by previously mentioned two ways can be changed by modify Dynamics CRM Web Address within Deployment Manager.

You can use the following to construct URL in FormLabrary

var serverUrl = document.location.protocol + '//' + document.location.host + '/' + Xrm.Page.context.getOrgUniqueName();

Xrm.Page.context.getServerUrl && Record URL(Dynamic) workflow dynamic values can return the base server URL which can be used either to construct web service URL (SOAP | REST) in FormLibrary or embed Record URL in a workflow.

According to SDK

The URL returned is the standard URL used to access the application. If you access the server locally using http://localhost or use an IP address rather than the actual name of the server, this will not be reflected in the value returned by this function. This means that if you are making web service calls or accessing web resources, Internet Explorer will apply security settings that apply to requests that cross domains. To avoid this, always connect to Microsoft Dynamics CRM using the standard URL.

CrmDataSource data source control connects to Dynamics CRM and retrieve EntityCollection

IOrganizationService.RetrieveMultiple(QueryExpression)
IOrganizationService.RetrieveMultiple(QueryByAttribute)

and make it available for other controls to bind to, without requiring code. It supports Select, Create, Update and Delete data.

1. Select

It supports FetchXml and QueryByAttribute to retrieve EntityCollection.

I: FetchXml

FetchXml string can be specified inside <FetchXml></FetchXml> node and parameters can be specified by using <SelectParameters></SelectParameters> node. Parameters in FetchXml must be prefixed with “@” symbol. System.Text.RegularExpressions.Regex.Replace is used to replace the parameter names with a value provided.

Example:

<crm:CrmDataSource ID="CrmDataSource1" runat="server">
 <FetchXml>
 <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
 <entity name="adx_webpage">
 <attribute name="adx_webpageid" />
 <attribute name="adx_name" />
 <attribute name="createdon" />
 <order attribute="adx_name" descending="false" />
 <filter type="and">
 <condition attribute="adx_name" operator="eq" value="@name" />
 </filter>
 </entity>
 </fetch>
 </FetchXml>
 <SelectParameters>
 <asp:Parameter Name="name" DefaultValue="Cases" />
 </SelectParameters>
</crm:CrmDataSource>
<asp:GridView ID="GridView1" runat="server" DataSourceID="CrmDataSource1">

<Columns>
 <asp:BoundField DataField='adx_name' HeaderText="Name" />
 <asp:BoundField DataField='createdon' HeaderText="Created On" />
 </Columns>
 </asp:GridView>

Results:

II: QueryByAttribute

QueryByAttribute can be specified inside <QueryByAttribute></QueryByAttribute> node and parameters can be specified by using <SelectParameters></SelectParameters> node. Parameters specified in QueryByAttribute must be prefixed with “@” symbol.

EntityName, Attributes, Values, ColumnSet, Orders are implicit parameter names, which can be specified as parameter name in <SelectParameters></SelectParameters> node.

While <SelectParameters> can be used to provide values to any parameters defined in <QueryByAttribute></QueryByAttribute> node; <QueryParameters></QueryParameters> values are only added to QueryByAttribute.Attributes and QueryByAttribute.Values.

Example:

<crm:CrmDataSource ID="CrmDataSource1" runat="server">
 <QueryByAttribute EntityName="adx_webpage">
 <Attributes>
 <asp:ListItem Value="@queryAttr"></asp:ListItem>
 </Attributes>
 <ColumnSet>
 <asp:ListItem Value="adx_webpageid"></asp:ListItem>
 <asp:ListItem Value="adx_name"></asp:ListItem>
 <asp:ListItem Value="@timestamp"></asp:ListItem>
 </ColumnSet>
 <Orders>
 <asp:ListItem Text="desc" Value="adx_name"></asp:ListItem>
 </Orders>
 <Values>
 <asp:ListItem Value="Home"></asp:ListItem>
 </Values>
 </QueryByAttribute>
 <SelectParameters>
 <asp:Parameter Name="timestamp" DefaultValue="createdon" />
 <asp:Parameter Name="queryAttr" DefaultValue="adx_name" />
 </SelectParameters>
 <QueryParameters>
 <asp:Parameter Name="adx_name" DefaultValue="Home" />
 </QueryParameters>
 </crm:CrmDataSource>
 <asp:GridView ID="GridView1" runat="server" DataSourceID="CrmDataSource1">
 <Columns>
 <asp:BoundField DataField='adx_name' HeaderText="Name" />
 <asp:BoundField DataField='createdon' HeaderText="Created On" />
 </Columns>
 </asp:GridView>

Result:

2. Update

CLR v2.0 applications now cannot see CLR v4.0 assemblies in the GAC.

Gacutil.exe can be used to install .NET 4 assembly into GAC.

Gacutil.exe (Global Assembly Cache Tool)

The physical location is
%windir%\Microsoft.NET\assembly\GAC_MSIL\

.NET 2 & .NET 3.5 assembly using CLR V2 and the GAC location is
%windir%\assembly\

1. Check assembly CLR version use IL Disassembler

Start -> All Programs -> Microsoft Visual Studio 2010 -> Microsoft Windows SDK Tools -> IL Disassembler -> File -> Open -> Double Click “MANIFEST”

2. Check assembly CLR version use C# code

string assemblyPath = @"D:\sdk 5.0.10\bin\microsoft.xrm.sdk.dll";
string clrVersion = System.Reflection.Assembly.ReflectionOnlyLoadFrom(assemblyPath).ImageRuntimeVersion;
Console.WriteLine(clrVersion);

3. View assembly in .NET 4 GAC using Gacutil.exe

gacutil -l >"D:\gac.txt"

4. View assembly in .NET 4 GAC using Windows Explorer

%windir%\Microsoft.NET\assembly\GAC_MSIL\

HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0_Config\TeamFoundation\SourceControl\Checkin Policies

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\VisualStudio\11.0\TeamFoundation\SourceControl\Checkin Policies

will return lead entity with id, revenue and transactioncurrencyid attributes, if they are not null.

SavedQueryDataSource data source control connects to Dynamics CRM and retrieve  savedquery entity, convert its fetchxml to QueryExpression, retrieve entities by using IOrganizationService.RetrieveMultiple(QueryExpression) and make these entities available for other controls to bind to, without requiring code. It only supports retrieving data.

It only works with savedquery NOT userquery. Savedquery is available to the entire organization and created using customization; userquery belongs to individual users and created using advanced find user interface.

Example:

<crm:SavedQueryDataSource ID="SavedQueryDataSource1" runat="server" SavedQueryName="Active WebPages">
 </crm:SavedQueryDataSource>
 <asp:GridView ID="GridView1" runat="server" DataSourceID="SavedQueryDataSource1">
 </asp:GridView>

Results:

More Information:

Use Saved Queries in a Portal

Walkthrough: Build a Web Application That Connects to Microsoft Dynamics CRM 2011 Using Developer Extensions

CrmEntityDataSource data source control expose a property “DataItem” of type object and make it available for other controls to bind to, without requiring code. It only supports retrieving value from CrmEntityDataSource.DataItem property.

If CrmSiteMapNode is assigned as the value for DataItem property, then the return value will be
new Entity[] { CrmSiteMapNode.Entity },
otherwise it will be
new object[] { CrmEntityDataSource.DataItem }.

DataItem property can be set in the .aspx markup by using ASP.NET Expressions/ExpressionBuilder (e.g. CrmSiteMap Expression).

More information regarding to ASP.NET expression can be found ASP.NET Expressions Overview  and ExpressionBuilder Class.

DataItem property can also be set in the .cs code behind.

Example:

<crm:CrmEntityDataSource ID="CrmEntityDataSource1" runat="server" DataItem='<%$ CrmSiteMap: Current %>'>
 </crm:CrmEntityDataSource>
 <asp:GridView ID="GridView1" runat="server" DataSourceID="CrmEntityDataSource1">
 </asp:GridView>

Result:

Server tags cannot contain <% … %> constructs
The code in the block can execute programming statements and call functions in the current page class during the page-rendering phase.

<%@ Page Language="VB" %>
<html>
<body>
 <form id="form1" runat="server">
 <% For i As Integer = 16 To 24 Step 2%>
 <div style="font-size: <% Response.Write(i)%>">
 Hello World<br />
 </div>
 <% Next%>
 </form>
</body>
</html>

<%= … %> displaying expression

equivalent of the embedded code block that contains only the Response.Write(…) statement. This is the simplest way to display information such as a single string, an int variable, or a constant.
displaying expression cannot be used in the attributes of server controls. This is because the .NET Framework directly compiles the whole expression instead of the displaying content as the value to the attribute.

<%@ Page Language="VB" %>
<html>
<body>
 <form id="form1" runat="server">
 <%=DateTime.Now.ToString() %>
 </form>
</body>
</html>

<%@ … %> directive expression

<%# … %> data-binding expression

The data-binding expression creates binding between a server control property and a data source when the control’s DataBind method of this server control is called on the page.

<%$ … %> expression builder

More information regarding to ASP.NET expression can be found ASP.NET Expressions Overview  and ExpressionBuilder Class.

<%– … — %> server-side comments block

<!– #include file|virtual=”filename” –> Server-Side Include Directive Syntax

More information:

Introduction to ASP.NET inline expressions in the .NET Framework

1. ConflictResolutionAction.SkipChange

e.SetResolutionAction(ConflictResolutionAction.SkipChange);

Neither source nor destination data store is updated.

It will be reflected through SyncOperationStatistics.DownloadChangesFailed or SyncOperationStatistics.UploadChangesFailed.

It will be counted as SyncOperationStatistics.DownloadChangesTotal or SyncOperationStatistics.UploadChangesTotal; because LoadChangeData is called on source provider.

ItemConflicting event will be raised for the same record during the next sync session.

2. ConflictResolutionAction.SaveConflict

The same effect as ConflictResolutionAction.SkipChange but with LoadChangeData is call one more time on source data source after ItemConflicting event is raised.

3. ConflictResolutionAction.DestinationWins

Based on the SyncDirectionOrder setting; source data store may be updated.

It will be reflected through SyncOperationStatistics.DownloadChangesApplied or SyncOperationStatistics.UploadChangesApplied.

It will be counted as SyncOperationStatistics.DownloadChangesTotal or SyncOperationStatistics.UploadChangesTotal.

ItemConflicting event will NOT be raised for the same record during the next sync session.

4. ConflictResolutionAction.SourceWins

Based on the SyncDirectionOrder setting; destination data store may be updated.

It will be reflected through SyncOperationStatistics.DownloadChangesApplied or SyncOperationStatistics.UploadChangesApplied.

It will be counted as SyncOperationStatistics.DownloadChangesTotal or SyncOperationStatistics.UploadChangesTotal.

ItemConflicting event will NOT be raised for the same record during the next sync session.

5. ConflictResolutionAction.Merge

When set resolution action to ConflictResolutionAction.Merge, ISimpleSyncProviderConcurrencyConflictResolver Interface need to be implemented. Based on the type of concurrency conflict the following three method will be called. ResolveLocalDeleteRemoteUpdateConflict, ResolveLocalUpdateRemoteDeleteConflict and ResolveUpdateUpdateConflict. Otherwise if these method is not implemented, it is treated as ConflictResolutionAction.SaveConflict.

You have to perform Create, Update, Delete operation in these three methods as the results of the resolution. (Except if a delete is the result of the resolution in either ResolveLocalDeleteRemoteUpdateConflict or ResolveLocalUpdateRemoteDeleteConflict, in this case SyncOrchestrator will invoke DeleteItem on the other provider)

CrmMetadataDataSource data source control connects to Dynamics CRM and retrieve  Metadata and make it available for other controls to bind to, without requiring code. It only supports retrieving data.

It can retrieve metadata for all entities (EntityMetadata[]) filtered by EntityFilters enum value set through MetadataFlags, attributes metadata for one single entity (AttributeMetadata[]) filter by EntityFilters enum value set through EntityFlags, and attribute metadata of type PicklistAttributeMetadata/StatusAttributeMetadata/StateAttributeMetadata  for one single entity (IEnumerable <new { sting OptionLabel, int OptionValue}>) ordered by value specified in SortExpression.

SelectParameters is ignored while retrieve metadata from Dynamics CRM.

Retrieve metadata for all entities

To retrieve metadata for all entities, leave both EntityName and AttributeName empty, and optionally specify MetadataFlags to limit the amount of information returned. MetadataFlags takes a value of EntityFilters type.

[Flags]
 public enum EntityFilters
 {
 All = 15,
 Attributes = 2,
 Default = 1,
 Entity = 1,
 Privileges = 4,
 Relationships = 8
 }

Example:

<crm:CrmMetadataDataSource ID="CrmMetadataDataSource1" runat="server" MetadataFlags="Attributes">
</crm:CrmMetadataDataSource>
<asp:GridView ID="GridView1" runat="server" DataSourceID="CrmMetadataDataSource1">
<Columns>
 <asp:BoundField DataField="DisplayName.UserLocalizedLabel.Label" HeaderText="Display Name" />
 <asp:TemplateField HeaderText="First Attribute">
 <ItemTemplate>
 <asp:Literal runat="server" Text='<%# Eval("Attributes[0].DisplayName.UserLocalizedLabel.Label") %>' />
 </ItemTemplate>
 </asp:TemplateField>
 <asp:TemplateField HeaderText="Second Attribute">
 <ItemTemplate>
 <asp:Literal runat="server" Text='<%# DataBinder.Eval(Container.DataItem, "Attributes[1].DisplayName.UserLocalizedLabel.Label") %>' />
 </ItemTemplate>
 </asp:TemplateField>
 <asp:TemplateField HeaderText="Third Attribute">
 <ItemTemplate>
 <asp:Literal runat="server" Text='<%# ((EntityMetadata)Container.DataItem).Attributes[2].DisplayName.UserLocalizedLabel == null ? string.Empty : ((EntityMetadata)Container.DataItem).Attributes[2].DisplayName.UserLocalizedLabel.Label.ToLower() %>' />
 </ItemTemplate>
 </asp:TemplateField>
 </Columns>
 </asp:GridView>

Result:

Tips on Data-Binding Expressions

1.

<%# Eval("expression") %>

is a short cut for

<%# DataBinder.Eval(Container.DataItem, "expression") %>

2. Container.DataItem can be used within <%# and %> delimiters to refer to  the current data item of the naming container.

3. Any publicly scoped code within the <%# and %>delimiters to execute that code and return a value during page processing.

4. For the cast ((EntityMetadata)Container.DataItem) in the example to work, register Microsoft.Xrm.Sdk.Metadata namespace in web.config

<system.web>
    <pages viewStateEncryptionMode="Always" validateRequest="true">
        <namespaces>
            <add namespace="Microsoft.Xrm.Sdk.Metadata"/>
        </namespaces>
    </pages>
</system.web>

More information regarding to Data-Binding Expressions can be found Data-Binding Expressions Overview and DataBinder.Eval Method

Notes:

At the moment there is a bug in Microsoft.Xrm.Client.Messages.OrganizationServiceContextExtensions.RetrieveAllEntities(this OrganizationServiceContext service, EntityFilters entityFilters = 1, bool retrieveAsIfPublished = false) method. Parameter with name “MetadataId” should not be added to the organization request, because this cause an exception with message “Unrecognized request parameter: MetadataId”.

Retrieve metadata for one single entity

To retrieve metadata for one single entity, leave AttributeName empty, specify EntityName and optionally specify EntityFlags  to limit the amount of information returned. EntityFlags  takes a value of EntityFilters type.

Example

<crm:CrmMetadataDataSource ID="CrmMetadataDataSource2" runat="server" EntityName="account" EntityFlags="All">
 </crm:CrmMetadataDataSource>
 <asp:GridView ID="GridView2" runat="server" DataSourceID="CrmMetadataDataSource2">
 <Columns>
 <asp:BoundField DataField="DisplayName.UserLocalizedLabel.Label" HeaderText="Display Name" />
 </Columns>
 </asp:GridView>

Result

Retrieve metadata for one attribute from specified entity

To retrieve metadata for one attribute from specified entity, specify AttributeName and EntityName and optionally specify SortExpression to control the order (Value/OptionValue, Label/OptionLabel, State, DefaultStatus can be used to sort).

This is limited to attributes of type type PicklistAttributeMetadata, StatusAttributeMetadata or StateAttributeMetadata only. The return value will be of type (IEnumerable <new { sting OptionLabel, int OptionValue}>).

Example:

<crm:CrmMetadataDataSource ID="CrmMetadataDataSource3" runat="server" EntityName="account" AttributeName="industrycode" SortExpression="Label DESC">
 </crm:CrmMetadataDataSource>
 <asp:GridView ID="GridView3" runat="server" DataSourceID="CrmMetadataDataSource3">
 </asp:GridView>

Result:

More Information can be found Use CrmMetadataDataSource Control

Microsoft Dynamics Labs has created “Customer Portal for Microsoft Dynamics CRM 2011” and “Partner Relationship Management Portal for Microsoft Dynamics CRM 2011” which can be accessed in Microsoft Dynamics market place.

This article series introduce how to use assemblies (microsoft.xrm.client.dll & microsoft.xrm.portal.dll) and portalbase solution to build portal.

1. Getting Started
2. ASP.NET Expression
   • Snippet/SiteSetting Expression
   • CrmSiteMap Expression
   • PortalContext/CurrentContact/Website Expression
   • TimeZone Expression
3. Data Source Web Server Controls
   • CrmDataSource
   • CrmEntityDataSource
   • CrmMetadataDataSource
   • SavedQueryDataSource
4. ASP.NET Data-Bound Web Server Controls
   • CrmEntityEditingManager
   • CrmEntityFormView
   • CrmListView
   • CrmSiteMapChildView
   • Property
   • Snippet
   • WebLinks
5. ASP.NET Web Server Controls
   • CrmHyperLink
   • DateTimeLiteral
   • EntityRightsView
   • LiveIdLoginStatus
   • WebLinkHyperLink
   • SiteEditingManager

TimeZone Expression

Syntax:

<%$ TimeZone: Name=name, Eval=eval, Format=format, Portal=portal%>
<%$ TimeZone: name, eval, format, portal%>

TimeZone Expression takes a format of comma separated name value pairs, any pair is optional and the name of the pair is optional as well. If name is omitted, then the sequence is significant.

The first name value pair (Name) can be set to “id” or ”displayname”. When it is set to “id” TimeZoneInfo.Id is the result of expression evaluation. When it is set to “displayname” TimeZoneInfo.DisplayName Id is the result of expression evaluation. When it is not specified , the following is returned.

System.Web.UI.DataBinder.Eval(TimeZoneInfo, eval, format)

A site setting named “timezone/id” is first checked, if it is not specified TimeZoneInfo.Local is used for the evaluation.

PortalContext Expression

Syntax:

<%$ Context: Property=property, Attribute=attribute, Eval=eval, Format=format, Default=default, Portal=portal%>
<%$ Context: property, attribute, eval, format, default, portal%>

PortalContext Expression takes a format of comma separated name value pairs, any pair is optional and the name of the pair is optional as well. If name is omitted, then the sequence is significant.

The first name value pair (Property) is the property name of IPortalContext instance. IPortalContext interface defined six properties:

public interface IPortalContext
{
    Microsoft.Xrm.Sdk.Entity Entity { get; }
    string Path { get; }
    OrganizationServiceContext ServiceContext { get; }
    System.Net.HttpStatusCode StatusCode { get; }
    Microsoft.Xrm.Sdk.Entity User { get; }
    Microsoft.Xrm.Sdk.Entity Website { get; }
}

If “Current” is specified as the value, the current PortalContext instance will be the result of the expression. If any other valide IPortalContext property name is specified, that property value is retrieved for the rest of the expression evaluation. If that property is null and the expression should be evaluated to a string value then the default value specified in 5th name value pair will be the result of the expression. Otherwise null will be returned from expression evaluation.

The second name value pair (Attribute) is only effective if the property of the previously retrieve property of IPortalContext is an Entity. If property of IPortalContext is an Entity, will be used for the rest of the evaluation, otherwise IPortalContext.Property is used for the rest of the evaluation. The value will be either

System.Web.UI.DataBinder.Eval(IPortalContext.Property[Attribute], eval, format)

or

System.Web.UI.DataBinder.Eval(IPortalContext.Property, eval, format)

Examples 1:

<asp:Literal runat="server" Text="<%$ Context: Property=Path%>" />

will produce the following output

~/Pages/Home.aspx?pageid=978e66cc-c8c6-4e5c-9ce0-d6ff153e9722

Examples 2:

<asp:Literal runat="server" Text="<%$ Context: Property=Entity, Attribute=Current, Eval=LogicalName%>" />

will produce the following output

adx_webpage

Examples 3:

<asp:Literal runat="server" Text="<%$ Context: Property=Entity, Attribute=adx_name%>" />

will produce the following output

Home

Examples 4:

<asp:Literal runat="server" Text="<%$ Context: Property=Website, Attribute=Current, Eval=LogicalName%>" />

will produce the following output

adx_website

Examples 5:

 <asp:Literal runat="server" Text="<%$ Context: Property=Website, Attribute=adx_name%>" /> 

will produce the following output

Cusomer Portal

CurrentContact Expression

CurrentContact Expression is a shortcut of PortalContext Expression with Property set to User

<%$ Context: Property=User, Attribute=attribute, Eval=eval, Format=format, Default=default, Portal=portal%>
<%$ Context: User, attribute, eval, format, default, portal%> 

Website Expression

Website Expression is a shortcut of PortalContext Expression with Property set to Website

<%$ Context: Property=Website, Attribute=attribute, Eval=eval, Format=format, Default=default, Portal=portal%>
<%$ Context: Website, attribute, eval, format, default, portal%> 

CrmSiteMap expression

More information regarding to ASP.NET Site Maps and SiteMapProvider Class

CrmSiteMap expression require ASP.NET sitemap feature enabled and Microsoft.Xrm.Portal.Web.CrmSiteMapProvider to be the default sitemap provider. CrmSiteMapProvider use Site Marker entity (adx_sitemarker) contained in portalbase solution as persistent store.This can be set up in web.config

<?xml version="1.0"?>
<configuration>
	<system.web>
		<siteMap enabled="true" defaultProvider="Crm">
			<providers>
				<clear/>
				<add name="Crm" type="Microsoft.Xrm.Portal.Web.CrmSiteMapProvider, Microsoft.Xrm.Portal" securityTrimmingEnabled="true"/>
			</providers>
		</siteMap>
	<system.web>
<configuration>

Syntax:

<%$ CrmSiteMap: SiteMarker=siteMarker, Return=return, Eval=eval, Format=format, Portal=portal%>
<%$ CrmSiteMap: siteMarker, return, eval, format, portal%>

Snippet Expression takes a format of comma separated name value pairs, any pair is optional and the name of the pair is optional as well. If name is omitted, then the sequence is significant.

The first name value pair (SiteMarker) is the value of Name attribute (adx_name) of Site Marker entity (adx_sitemarker) contained in portalbase solution.

One instance of CrmSiteMapNode will be created for the rest of expression evaluation.

CrmSiteMapNode contains four more extra properties than base ASP.NET SiteMapNode object: Entity, LastModified, RewriteUrl and StatusCode. The entity will be the Web Page (adx_webpage) entity instance related to the Site Marker entity (adx_sitemarker) with the name specified.

The Web Page (adx_webpage) entity will be retrieved from CRM first, and the Partial Url (adx_partialurl) attribute value will be used to find CrmSiteMapNode within sitemap. If special value “Current” is specified, the current web page path will be used to find CrmSiteMapNode within sitemap.

CrmSiteMapProvider use Site Marker entity (adx_sitemarker) contained in portalbase solution as persistent store. SiteMap is defined as a view of Site Marker entity for the specified web site. If the partial url/web page path from the previous description is found in this list of Site Marker entities. A corresponding CrmSiteMapNode will be created otherwise one CrmSiteMapNode instance with “Page Not Found” Site Marker will be created. If “Page Not Found” Site Marker does not exist in CRM, null will be returned.

The second name value pair (Return) can be set to either “Entity” or “Url“, if it is not specified the value of Eval and Format will determine the expression value, if any other value is specified an instance of CrmSiteMapNode will be returned.

If it is set to “Entity”, the value of the expression will be the Web Page (adx_webpage) entity instance related to the Site Marker entity (adx_sitemarker) with the name specified for the first name value pair.

If it is set to “Url”, the value of the expression will be the Partial Url (adx_partialurl) attribute value of the Web Page (adx_webpage) entity instance related to the Site Marker entity (adx_sitemarker) with the name specified for the first name value pair.

If we have the following web page created within CRM (Name=”View Scheduled Services” Partial Url=”view-scheduled-services”)

the following Site Marker created within CRM which related to the previous web page (Name=”View Scheduled Services” Page=”View Scheduled Services”)

The following expression

<asp:Literal ID="Literal1" runat="server" Text="<%$ CrmSiteMap: SiteMarker=View Scheduled Services, Return=Entity%>" />

will produce the following error, this verify that the value of the CrmSiteMap expression is an Entity with logical name “adx_webpage”

The following CrmSiteMap expression will be evaluated to “/view-scheduled-services”

<asp:Literal ID="Literal1" runat="server" Text="<%$ CrmSiteMap: SiteMarker=View Scheduled Services, Return=Url%>" />

The third and fourth name value pair (Eval & Format) will only be taken into consideration when second name value pair (Return) is not specified. The value then will  be passed as parameters to System.Web.UI.DataBinder.Eval(CrmSiteMapNode, eval, format) and the value is substituted for the expression syntax when the second name value pair is not specified.

The following expression will product “Partial Url is: /view-scheduled-services”

<asp:Literal ID="Literal1" runat="server" Text="<%$ CrmSiteMap: SiteMarker=View Scheduled Services, Eval=Url, Format=Partial Url is {0}%>" />

Getting Started

1. Import solution from sdk\Solutions\PortalBase\MicrosoftXrmPortals_managed.zip. Detailed steps can be found Install the Base Portal Solution

The following navigation will be available in crm after import portal base solution

2. Create a new website, set the name of the website to “Hello World Portal“

3. create a new Content Snippet, set the name of the snippet to “HelloWorld“, value to “Hello World!!!“

4. Create a new empty web application in Visual Studio

5. Add reference to microsoft.xrm.client and microsoft.xrm.portal in sdk\bin\

6. Replace web.config with the following, change connectionString value

<?xml version="1.0"?>
<configuration>
    <configSections>
        <section name="microsoft.xrm.client" type="Microsoft.Xrm.Client.Configuration.CrmSection, Microsoft.Xrm.Client"/>
        <section name="microsoft.xrm.portal" type="Microsoft.Xrm.Portal.Configuration.PortalCrmSection, Microsoft.Xrm.Portal"/>
    </configSections>
    <connectionStrings>
        <add name="Xrm" connectionString="ServiceUri=http://win-b1dmdctdenr/ :5555/Cleanup;"/>
    </connectionStrings>
    <system.web>
        <compilation debug="true" targetFramework="4.0">
            <expressionBuilders>
                <add expressionPrefix="Snippet" type="Microsoft.Xrm.Portal.Web.Compilation.SnippetExpressionBuilder, Microsoft.Xrm.Portal"/>
            </expressionBuilders>
        </compilation>
    </system.web>
    <microsoft.xrm.client>
        <contexts>
            <add name="Xrm" type="Microsoft.Xrm.Client.CrmOrganizationServiceContext, Microsoft.Xrm.Client"/>
        </contexts>
    </microsoft.xrm.client>
    <microsoft.xrm.portal>
        <portals>
            <add name="Hello World Portal"/>
        </portals>
    </microsoft.xrm.portal>
</configuration>

7. Add HelloWorld.aspx to the project and set as start page

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="HelloWorld.aspx.cs" Inherits="HelloWorldPortal.HelloWorld" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd ">
<html xmlns="http://www.w3.org/1999/xhtml ">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <h1><asp:Literal runat="server" Text="<%$ Snippet: HelloWorld %>" /></h1>
    </div>
    </form>
</body>
</html>

8. Debug web application, check result.

Snippet Expression

More information regarding to ASP.NET expression can be found ASP.NET Expressions Overview  and ExpressionBuilder Class.

There are 7 expression builders contained in microsoft.xrm.portal.dll assembly.

• CrmSiteMapExpressionBuilder
• CurrentContactExpressionBuilder
• PortalContextExpressionBuilder
• SiteSettingExpressionBuilder
• SnippetExpressionBuilder
• TimeZoneExpressionBuilder
• WebsiteExpressionBuilder

Expression builders need to be registered in web.config

<configuration>
    <system.web>
        <compilation debug="true" targetFramework="4.0">
            <expressionBuilders>
                <add expressionPrefix="Snippet" type="Microsoft.Xrm.Portal.Web.Compilation.SnippetExpressionBuilder, Microsoft.Xrm.Portal"/>
                <add expressionPrefix="SiteSetting" type="Microsoft.Xrm.Portal.Web.Compilation.SiteSettingExpressionBuilder, Microsoft.Xrm.Portal"/>
                <add expressionPrefix="CrmSiteMap" type="Microsoft.Xrm.Portal.Web.Compilation.CrmSiteMapExpressionBuilder, Microsoft.Xrm.Portal"/>
                <add expressionPrefix="Context" type="Microsoft.Xrm.Portal.Web.Compilation.PortalContextExpressionBuilder, Microsoft.Xrm.Portal"/>
            </expressionBuilders>
        </compilation>
    </system.web>
</configuration>

Snippet Expression

Snippet Expression evaluated to Value attribute (adx_value) of Content Snippet entity instance (adx_contentsnippet) contained in portalbase solution.

Syntax:

<%$ Snippet: Name=somename, Default=defaultvalue, Format=stringformat, Portal=someportal %>
<%$ Snippet: somename, defaultvalue, stringformat, someportal %>

Snippet Expression takes a format of comma separated name value pairs, any pair is optional and the name of the pair is optional as well. If name is omitted, then the sequence is significant.

The first name value pair (Name) is the value of Name attribute (adx_name) of Content Snippet entity (adx_contentsnippet) contained in portalbase solution. The value of the expression will be evaluated as the value of Value attribute (adx_value) of the same entity instance.

The second name value pair (Default) is the value to be taken for the result of the expression evaluation if an instance of Content Snippet entity (adx_contentsnippet) with the specified Name attribute (adx_name) does not exist for the portal in the connected Microsoft Dynamics CRM 2011 instance.

The third name value pair (Format) is going to be passed as a parameter to string.Format(format,  adx_value) and the value is substituted for the expression syntax.

The fourth name value pair (Portal) is checked against configured portals in the web.config file and used to create IPortalContext instance

<microsoft.xrm.portal>
    <portals>
        <add name="Customer Portal"/>
    </portals>
</microsoft.xrm.portal>

This value should be the value of Name attribute (adx_name) of Website entity (adx_website) contained in portalbase solution.

Assume we have the following website created in CRM

two different snippets created in each website

two portals configured in web.config for each website inside CRM

<microsoft.xrm.portal>
    <portals>
        <add name="Customer Portal"/>
        <add name="Test Portal"/>
    </portals>
</microsoft.xrm.portal>

The following expression

<table>
        <thead>
            <tr>
                <th>Name</th>
                <th>Default</th>
                <th>Format</th>
                <th>Portal</th>
                <th>Value</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>Custom Snippet A</td>
                <td>defaultA</td>
                <td>Value: {0}</td>
                <td>Customer Portal</td>
                <td>
                    <asp:Literal runat="server" Text="<%$ Snippet: Name=Custom Snippet A, Default=defaultA, Format=Value: {0}, Portal=Customer Portal %>" />
                </td>
            </tr>
            <tr>
                <td>Custom Snippet A</td>
                <td>defaultA</td>
                <td>Value: {0}</td>
                <td>Test Portal</td>
                <td>
                    <asp:Literal runat="server" Text="<%$ Snippet: Name=Custom Snippet A, Default=defaultA, Format=Value: {0}, Portal=Test Portal %>" />
                </td>
            </tr>
            <tr>
                <td>Test Snippet B</td>
                <td>defaultB</td>
                <td>Value: {0}</td>
                <td>Customer Portal</td>
                <td>
                    <asp:Literal runat="server" Text="<%$ Snippet: Name=Test Snippet B, Default=defaultB, Format=Value: {0}, Portal=Customer Portal %>" />
                </td>
            </tr>
            <tr>
                <td>Test Snippet B</td>
                <td>defaultB</td>
                <td>Value: {0}</td>
                <td>Test Portal</td>
                <td>
                    <asp:Literal runat="server" Text="<%$ Snippet: Name=Test Snippet B, Default=defaultB, Format=Value: {0}, Portal=Test Portal %>" />
                </td>
            </tr>
        </tbody>
    </table>

will produce the result

SiteSetting Expression

SiteSetting Expression works the same way as Snippet Expression. It takes the same 4 name and value pairs but read value from Site Settings (adx_sitesetting) entity contained in portalbase solution

GET
POST
PUT
DELETE
HEAD
TRACE
OPTIONS
CONNECT

HTTP Request Headers:

Accept
Accept-Charset
Accept-Encoding
Accept-Language
Authorization
Cookie
Expect
From
Host
If-Match
If-Modified-Since
If-None-Match
If-Range
If-Unmodified-Since
Max-Forwards
Proxy-Authorization
Range
Referer
TE
User-Agent

HTTP Response Status Codes

Informational (100-199)
Successful (200-299)
Redirection (300-399)
Client error (400-499)
Server error (500-599)

100 Continue
101 Switching Protocols

200 OK
201 Created
202 Accepted
203 Non-Authoritative Information
204 No Content
205 Reset Content
206 Partial Content

300 Multiple Choices
301 Moved Permanently
302 Found
303 See Other (302 Found | Get)
304 Not Modified
305 Use Proxy
306 * Deprecated *
307 Temporary Redirect (302 Found | same request method)

400 Bad Request
401 Unauthorized
402 Payment Required
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Not Acceptable
407 Proxy Authentication Required
408 Request Timeout
409 Conflict
410 Gone
411 Length Required
412 Precondition Failed
413 Request Entity Too Large
414 Request-URI Too Long
415 Unsupported Media Type
416 Requested Range Not Satisfiable
417 Expectation Failed

500 Internal Server Error
501 Not Implemented
502 Bad Gateway
503 Service Unavailable
504 Gateway Timeout
505 HTTP Version Not Supported

HTTP Response Headers

Accept-Ranges (bytes | none)
Age
Authentication-Info (HTTP digest authentication)
Content-Disposition (suggested filename)
ETag
Location
Proxy-Authenticate
Refresh (meta http-equiv=”refresh” content=”3; url=http://httphandbook.org/”)
Retry-After (503 or any of the 300-range (redirection) status codes)
Server
Set-Cookie
Vary (cache proxy)
WWW-Authenticate

HTTP General Headers

• Cache-Control

HTTP Request
	no-cache (do not cache http headers specified)
	no-store (do not cache current http request & response)
	max-age
	max-stale (extend expiration date of the resource for the purpose of caching)
	min-fresh (reduce expiration date of the resource for the purpose of caching)
	no-transform (do not modify the content part of the HTTP response)
	only-if-cached (do not contact server, send cache back to client)
	cache-extension (specify not explicitly defined directives)
HTTP Response
	public (any caching by any caching system)
	private (allows caching, but not on shared caches | browser cache is private)
	no-cache
	no-store
	no-transform
	must-revalidate (must revalidate after expired)
	proxy-revalidate (must-revalidate exclude private caches)
	max-age
	s-maxage (max-age exclude private caches)
	cache-extension

• Connection (HTTP connection management | TCP)(Keep-Alive | Close | Upgrade)
• Date (system time when request was generated on Browser or response was generated on Server)
• Pragma (caching in HTTP/1.0) (Pragma: no-cache) (forward request or response to server or browser)
• Keep-Alive (maximum amount of time that the TCP connection can remain open) (require Connection general header have a value of Keep-Alive)
• Trailer (include some HTTP headers after the content) (require Transfer-Encoding: chunked)
• Transfer-Encoding (each piece of the content begins with a hexadecimal value of the length of the next chunk on a line by itself)
• Upgrade (negotiate a change in protocol)
• Via (proxies add their name to “Via” header as they forward messages)
• Warning

	110 Response is stale
	111 Revalidation failed
	112 Disconnected operation
	113 Heuristic expiration
	199 Miscellaneous warning
	214 Transformation applied
	299 Miscellaneous persistent warning

HTTP Entity Headers

Allow
Content-Encoding (compress | deflate | gzip)
Content-Language
Content-Length (the length of the content section of the HTTP message in bytes)
Content-Location (the URL of the resource being returned differs from the URL being requested)
Content-MD5 (MD5 && Base-64 encoding)
Content-Range (Content-Range: 600-900/1234)
Content-Type (Content-Type: text/html)
Expires
Last-Modified

HTTP Formatting Specifications

Line Termination: CRLT (carriage return plus a line feed, \r\n)
Content Separation: empty line
Header Formatting: Header-Name: value
Date Formats: Tue, 21 May 2002 12:34:56 GMT
URL Encoding: ISO-Latin characters 32-126, Reserved characters is encoded as a percent sign (%), followed by the hexadecimal value of the character
HTML entities: is encoded as “&#xxx;” where xxx represents the decimal value of the character (“& a m p ;” is an ampersand)

HTTP Media Types

• application
• audio
• image
• message
• model
• multipart
• text
• video

The most current list of all registered media types can be found at http://www.iana.org/assignments/media-types/index.html

Internet Options –> Advanced –> Browsing –> “Disable script debugging (Internet Explorer)” = OFF
Internet Options –> Advanced –> Browsing –> “Disable script debugging (Other)” = OFF
Internet Options –> Advanced –> Browsing –> “Show friendly HTTP error messages” = OFF
Internet Options –> General–> Browsing history –> Settings –> Check for newer versions of stored pages: == “Every time I visit the webpage”

Clear cache
Internet Options –> General–> Browsing history –> Delete… –>
Uncheck “Preserve Favorites website data”
Check “Temporary Internet files” “Cookies”
–> Delete

Dynamics CRM:
Set the DevErrors attribute to On in the Web.config file.

Firefox:

visit about:config, find the browser.cache.check_doc_frequency and change it to 1.

0 – Check for a new version of a page once per session (a session starts when the first application window opens and ends when the last application window closes).

1 – Check for a new version every time a page is loaded.

2 – Never check for a new version – always load the page from cache.

3- Check for a new version when the page is out of date. (Default)

http://www.imasuper.com/53/technology/firefox-caching-get-latest-page-every-time