SDK Release History for V5.0.13

[Applies to: Microsoft Dynamics CRM 2011]

This page contains the list of significant changes made to the SDK version 5.0.13, December 2012 for Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online.

New and updated topics

Description of changes


Updated the assemblies for Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update. For on-premises customers, updates and hotfixes can be installed automatically from Microsoft Update. You can also search for updates on the Microsoft Download Center. For online customers, update rollups will be deployed automatically to your organization.


Updated the readme for this version of the SDK package.


Updated exported ribbon definitions for Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update.


Updated the samples for Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update.



Added support for the Microsoft online services environment to connect to Microsoft Office 365.

Renamed LiveIdAuthenticationPolicy.cs to OnlineAuthenticationPolicy.cs and made the same change for the VB version of that file.

Table of Contents

Redesigned the table of contents with less nesting to promote visibility of information. The following topics have been renamed for better search results:

Write Code for Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online (Web Services, JavaScript) renamed to Write Applications and Server Extensions

Extend Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online renamed to Write Client Application Extensions

The XML schema references have been moved from the programming reference to be located with the relevant conceptual topics. However, you can still find them by using the Programming Reference topic.

What's New for Developers

Updated for Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update.

Activity Feeds Entities

Introduction to Activity Feeds

Configure Activity Feeds

Added information about the new Like/Unlike feature. Updated information about default number of records that you can follow, and the maximum allowed number of characters in the post and the post comment. Also, updated configuration information about obtaining full functionality for activity feeds.

Analyze Plug-in Performance

Create a Custom Workflow Activity

Custom Workflow Activities (Workflow Assemblies) for Microsoft Dynamics CRM

Debug a Plug-In

Plug-in Isolation, Trusts, and Statistics

Register and Deploy Plug-Ins

Register and Use a Custom Workflow Activity Assembly

Troubleshooting Tips

Custom workflow activities can now be registered in the sandbox and are supported by Microsoft Dynamics CRM Online. These topics were updated to reflect that change.

Analyze Plug-in Performance

Register and Deploy Plug-Ins

Register and Use a Custom Workflow Activity Assembly

Walkthrough: Register a Plug-in Using the Plug-in Registration Tool

Walkthrough: Register an Azure-Aware Plug-in with Plug-in Registration Tool

The Plug-in Registration tool executable file can now be found in the Bin folder of the SDK download. The source code for the tool has been removed from the SDK download. These topics were updated to reflect that change.

Browse the Metadata for Your Organization


Updated the metadata browser to version 2.0. This new metadata browser includes the following changes:

  • Supports browsers other than Internet Explorer.

  • Allows for filtering entities by all property values.

  • Allows for filtering properties that are displayed.

  • Replaced the context menu options with buttons to improve discoverability.

  • Added support for sorting grid columns.

For more information, see SDK\Tools\MetadataBrowser\Readme.docx.

<CheckBox> (RibbonDiffXml)
<TextBox> (RibbonDiffXml)

Updated the TemplateAlias attribute to show that these elements cannot be associated with a template alias that represents an <OverflowSection> (RibbonDiffXml) or a <ControlRef> (RibbonDiffXml) element that uses the large display mode.

Choose Your Solution Development Environment

Added a new topic to address issues related to solution development when Microsoft Dynamics CRM Online includes features that cannot be enabled in an on-premises deployment of Microsoft Dynamics CRM 2011.

Client-Side Context Reference

Added information about the new getClientUrl method. This method returns the base URL that was used to access the application. This is now the recommended method to use to access the organization URL. The getServerUrl method is deprecated.

Create and Deploy Workflow Libraries Using the Developer Toolkit

Updated the topic to reflect that workflow libraries can now be deployed on Microsoft Dynamics CRM Online. There is one additional step in the procedure to register the assembly in sandbox isolation mode.

Create, Export, or Import an Unmanaged Solution

Added a note to the Export an Unmanaged Solution section to indicate that, after Microsoft Dynamics CRM 2011 Update Rollup 12 and Microsoft Dynamics CRM December 2012 Service Update, un-customized form definitions will no longer be exported with unmanaged solutions.

Customize Entity Views

Added information in the introduction to explain the differences between SavedQuery and UserQuery.

Design Considerations for Different Form Presentations

Updated and retitled this topic. Formerly titled “Design Considerations for Read-Only Forms,” this topic now addresses all types of forms, including information about the updated forms used in the Microsoft Dynamics CRM December 2012 Service Update.

Developer Toolkit for Microsoft Dynamics CRM

The Developer Toolkit for Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online now supports Microsoft Visual Studio 2012.


Added details about which settings are included when the following members are included with this request:


Helper Code: ServerConnection Class


Added a null check for the UserPrinicipalName in the user principal assignment section. If null, the user is prompted for the user ID and password in the console.

Introduction to Solutions

Added a new Using Microsoft Dynamics CRM Online as Your Environment to Develop Solutions section to provide guidance about issues related to installing managed solutions that were generated from a Microsoft Dynamics CRM Online environment where the product updates included in the Microsoft Dynamics CRM December 2012 Service Update are installed. When a solution from this environment is installed in an organization that does not have these product updates installed, the user will have an option to ignore missing dependencies.

Updated the Conflict Resolution section to add a note advising that form and sitemap changes included in a managed solution update will not overwrite any unmanaged customizations to those components even when the Overwrite customizations option is selected.

Introduction to Windows Azure Integration with Microsoft Dynamics CRM

Sample: Persistent Queue Listener

ServiceEndpoint Entity OptionSet Attribute Metadata

Understand the Data Context Passed to a Plug-In

Walkthrough: Configure Windows Azure ACS (Version 2) for Microsoft Dynamics CRM Integration

Write a Custom Azure-Aware Plug-In

Write a Listener for a Windows Azure Solution


Added new and updated information about using Windows Azure with Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online. Includes new support for Windows Azure persistent queues, use of the updated Windows Azure portal to configure ACS, and synchronous plug-in support for posting to the service bus. Added a new sample to demonstrate how to write a persistent queue listener.

Lead Entity Metadata

Lead Entity OptionSet Attribute Metadata

Opportunity Entity Metadata

Opportunity Entity OptionSet Attribute Metadata

Incident (Case) Entity Metadata

Incident (Case) Entity OptionSet Attribute Metadata

Updated to include new attributes and option set values that support new updated user experience interface and product update functionality.

<MRUSplitButton> (RibbonDiffXml)

Updated this topic to indicate that setting the QueryCommand attribute for the MRUSplitButton is not supported. It is for internal use only. There is no supported way to query for the most recently used items.

Open Forms, Views, Dialogs and Reports with a URL

Updated this topic to add the Save & Close or Finish Buttons May Not Work When a Window is Opened From a Link section and include guidance about using Xrm.Page.context.getClientUrl rather than the deprecated getServerUrl method.

Added the Opening a Report by Using a URL section.

Retrieve and Detect Changes to Metadata

Added a new topic for the new metadata query capabilities included in the Microsoft.Xrm.Sdk.Metadata.Query namespace.


Updated the notes to provide guidance to avoid time-out issues when using this request with Microsoft Dynamics CRM Online when there are a large amount of customizations in the organization.

Sample: Create an Organization using an Asynchronous Deployment Request


Added a new sample to show how to us an asynchronous message with the deployment web service and to poll for completion. This sample uses the BeginCreateOrganizationRequest message.

Sample: Detect Multiple Duplicate Records


Added a new sample to show how to use the BulkDetectDuplicatesRequest message to detect multiple duplicate records for a specified entity type.

Sample: Detect When an Object is Available Using Script in a Web Resource and an Updated Form


Added a new sample to show a way to deal with the situation where portions of the Xrm.Page object load into the updated forms asynchronously so they may not be available to scripts in HTML web resources at load time.

Sample: Initialize a Record From an Existing Record


Added a new sample to show how to use the InitializeFromRequest message to create new records from an existing record.

Sample: One-Way Listener

Sample: REST Listener

Sample: Two-Way Listener


Updated these samples to build with newer versions of the Windows Azure SDK, version 1.7 or 1.8.

Sample: Query Metadata and Detect Changes


Added a new sample to show how to use the classes in the Microsoft.Xrm.Sdk.Metadata.Query namespace.

Sample: Reassign All Records


Added a new sample to show how to use the ReassignObjectsOwnerRequest message to reassign leads from one user to another user or team. It also shows how to use the SetBusinessSystemUserRequest message to reassign one user from the root business unit to a different business unit.

Sample: Retrieve Currency Exchange Rate


Added new sample to show how to create a new currency and to retrieve the currency exchange rate by using the RetrieveExchangeRateRequest message.

Sample: Retrieve Entity Metadata Using JavaScript


This library was completely rewritten to provide a better example, and reduce its size. Rather than depending on static definitions of metadata within the code, this sample converts the XML that is retrieved into JavaScript objects.

Sample: Retrieve License Information


Added a new sample to shows how to use the RetrieveDeploymentLicenseTypeRequest and the RetrieveLicenseInfoRequest messages to retrieve information about licenses.

Sample: Search and Retrieve Articles


Added a new sample to show how to search for articles by body, keyword, and title, and retrieve articles by topic incident subject and topic incident product.

The sample uses the following messages:

Sample: Validate and Execute a Saved Query


Added a new sample to show how to use the ValidateSavedQueryRequest message to validate a FetchXML query and then use the ExecuteByIdSavedQueryRequest message to execute the query.

Security Role UI to Privilege Mapping

Security Role and Privilege Reference

Updated the privileges information for Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update.

Supported Extensions for Microsoft Dynamics CRM

Updated the Unsupported Customizations section to show that Silverlight Application Library Caching is not supported.

Use Advanced Configuration Settings (ConfigDB)

Added new advanced settings information for Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update.

Use an IFRAME and Web Resource Controls on a Form

Updated the Select Whether to Restrict Cross-Frame Scripting section to describe the behavior for browsers other than Internet Explorer.

Use ExecuteMultiple to Improve Performance for Bulk Data Load

Sample: Execute Multiple Requests


Added documentation and sample code for the new data load feature where multiple message requests can be executed by sending an ExecuteMultipleRequest to the web service.

Use JavaScript with Microsoft Dynamics CRM

Updated the topic to include information related to support for browsers other than Internet Explorer.

Walkthrough: Connect Using Java for Microsoft Dynamics CRM Online


Added support for the Microsoft online services environment to connect to Microsoft Office 365.

Walkthrough: Use the SOAP Endpoint for Web Resources with Silverlight

Changed the service URL example in the Add a Service Reference to the Organization Service procedure from <organization URL>/XRMServices/2011/Organization.svc to <organization URL>/XRMServices/2011/Organization.svc?wsdl.

Web Page (HTML) Web Resources

Updated the table in the Passing Parameters to HTML Web Resources section to indicate that formid, pagemode, security, and tabSet are also parameters that web resources can accept.

What's New for Developers

Added a new section Updated User Experience for Sales and Customer Service and Product Update Functionality. It contains information about the new updated user experience interface provided on the Lead, Opportunity, and Case forms, and introduces the Product Update functionality. It also describes the new entity attributes and other changes that support the new functionality. Attribute Methods

Updated information about the getMaxLength method to explain that the email form description attribute is a memo attribute, but does not have a getMaxLength method.

Xrm.Page Sample Libraries

Updated all the form script library samples to make it easier to understand how namespaces are applied to individual functions.

Xrm.Page.ui Control Methods

For the getControlType method, notes controls now return “notes” rather than “standard.”

<Ancestor> (FormXml)

<ControlMode> (FormXml)

<EnableContextualActions> (FormXml)

<EntityLogicalName> (FormXml)

<InlineViewIds> (FormXml)

<IsInlineNewEnabled> (FormXml)

<LinkControlDefinitionId> (FormXml)

<QuickFormRelationshipName> (FormXML)

<QuickFormRelationshipRoleOrdinal> (FormXml)

<ShowInROF> (FormXml)

<UniqueId> (FormXml)

Added information about the new parameters for the Quick Form control, the Link control, web resource controls, the Lookup control, and Subgrid controls.

See Also

Other Resources

Release History
Software Development Kit for Microsoft Dynamics CRM

Microsoft Dynamics CRM 2011
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.