Release history

 

Applies To: Dynamics CRM 2013

This is the release history page for the Software Development Kit (SDK) for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online.

Current Version: 6.1.2, January 2017

In this topic

Release History for SDK Version 6.1.2, January 2017

Release History for SDK Version 6.1.1, September 2014

Release History for SDK Version 6.1.0, May 2014

Release History for SDK Version 6.0.4, February 2014

Release History for SDK Version 6.0.3, December 2013

Release History for SDK Version 6.0.2, December 2013

Release History for SDK Version 6.0.1, October 2013

Release History for SDK Version 6.0.0, September 2013

Release History for SDK Version 6.1.2, January 2017

Updated assembly

Description of changes

SDK\Bin\Microsoft.Xrm.Sdk.dll

Updated the Microsoft.Xrm.Sdk.dll assembly to support projects using Microsoft .NET Framework 4. With the deprecation of Microsoft Azure Access Control Service (ACS), we have modified authentication code by removing all references to ACS. Projects using Microsoft .NET Framework 4.5.2 should use the latest Dynamics 365 SDK assemblies. More information: Microsoft Dynamics 365 Team blog post: Dynamics 365 SDK Backwards Compatibility.

Release History for SDK Version 6.1.1, September 2014

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Update Rollup 1 for Microsoft Dynamics CRM 2013 Service Pack 1. These assemblies are also compatible with Microsoft Dynamics CRM Online Spring ‘14.

SDK\Bin\CrmSvcUtil.exe

The program was updated to correct a problem where a connection couldn’t be established to Microsoft Dynamics CRM Online using the Office 365 identity provider.

Command bar or ribbon presentation

Updated the Different presentations of commands section to show that the maximum number of commands visible in a form command bar was increased from five to seven.

Create a new service namespace

Updated the procedure to reflect recent changes in the Microsoft Azure management portal. It’s no longer possible to create a new Microsoft Azure Access Control Service (ACS) namespace using the management portal.

Form XML reference

Added information about two timer control parameters : <FailureConditionName> (FormXml) and <FailureConditionValue> (FormXml). Also updated Form XML schema.

Incident (case) entity messages and methods

Added a note to document that the PrimaryContactId lookup attribute introduced with the CRM Online Spring ‘14 and Microsoft Dynamics CRM 2013 Service Pack 1 (SP1) release should be considered the primary system lookup attribute to associate incidents with a contact record. This lookup attribute should be used instead of the ResponsibleContactId lookup attribute.

Types of calendars

Corrected the description for the default calendar type.

Old description: Business closure calendars for service scheduling.

New description: All calendars that are not customer service, holiday schedule, or inner calendars.

What's changing in the next release

Changed the Forms section to show that upgrading previously upgraded forms won’t be required in the next release, but it’s recommended. Also removed information about read-optimized forms because these were removed in the current release.

Xrm.Page.ui control (client-side reference)

Added a new JavaScript sample for the addCustomFilter method.

Release History for SDK Version 6.1.0, May 2014

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Microsoft Dynamics CRM 2013 Service Pack 1 (SP1). These assemblies are also compatible with Microsoft Dynamics CRM Online Spring ‘14.

SDK\ SampleCode\CS\HelperCode\ErrorCodes.cs

SDK\ SampleCode\VB\HelperCode\ErrorCodes.vb

Added new error messages.

Microsoft_Dynamics_CRM_2013_SDK_Readme.htm

Updated for this release.

What's new for developers

Provided an overview of new features for this release.

Authenticate the user with the web services

Updated the topic and added documentation on run-time discovery of the OAuth endpoint URL.

Best practices for developing with Microsoft Dynamics CRM 2013

Added more information on real-time workflows.

Build Windows client applications using the XRM tools

Added new topics on using the new XRM Tooling APIs to build your Windows client applications for CRM that enable you to make calls to CRM in a thread-safe environment, provide a common sign-in control to sign in to CRM, and help you read data from image and XML web resources.

Create packages for the CRM Package Deployer

Added a new topic to describe the Microsoft Dynamics CRM Package Deployer, a new tool that enables administrators to deploy packages on CRM servers.

Create your own actions

Added the Execute an action using a JavaScript web resource section to include information about executing actions using JavaScript.

CRM messages in the organization service

Added the following topics to provide information on new messages included in this release:

AddPrincipalToQueueRequest
AddPrincipalToQueueResponse
ApplyRoutingRuleRequest
ApplyRoutingRuleResponse
GenerateSocialProfileRequest
GenerateSocialProfileResponse
PickFromQueueRequest
PickFromQueueResponse
ReleaseToQueueRequest
ReleaseToQueueResponse
RemoveFromQueueRequest
RemoveFromQueueResponse
RenewEntitlementRequest
RenewEntitlementResponse
RouteToRequest
RouteToResponse

Define custom state model transitions

Added a new topic to describe a feature that allows for filtering of valid status transitions. Sample: Retrieve Valid Status Transitions provides a method that can be used for any entities that support this capability.

Deployment entities and deployment configuration settings

Added new configuration types for this release:

MonitoringSettings
MonitoringSettings

Updated the following types with new values for this release:

ServerSideSyncACTSettings
ServerSideSyncEmailSettings
ServerSideSyncQueueSettings
ThrottleSettings

Detect duplicate data

Added a note about duplicate detection capability being re-introduced for the updated user interface (UI) entities on create or update of the records, in forms or list views. Also, added a note about duplicate detection being introduced in Microsoft Dynamics CRM for tablets.

Detect enhanced service capabilities available with product updates

Added new topic to describe how to detect whether product updates enabling new enhanced service capabilities are installed and how to create a new development organization without updates installed.

Export a solution for a specific CRM version

Added a new topic to describe new capabilities to specify a target version when exporting a solution.

Form XML reference

Added or updated the following topics for new schema elements to support the service level agreement (SLA) timer control:

Form XML schema
<CancelConditionName> (FormXml)
<CancelConditionValue> (FormXml)
<FailureTimeField> (FormXml)
<SuccessConditionName> (FormXml)
<SuccessConditionValue> (FormXml)
<WarningConditionName> (FormXml)
<WarningConditionValue> (FormXml)

Generate entity diagrams with the metadata diagram tool

Updated DiagramBuilder.cs to use entity logical name instead of schema name.

Global option set metadata values

Updated with new values for this release.

Helper code: SystemUserProvider class

SDK\SampleCode\CS\HelperCode\SystemUserprovider.cs
SDK\SampleCode\VB\HelperCode\SystemUserprovider.vb

Added passing the user’s credentials for Active Directory operations. This change was required for compatability with Windows Server 2012.

Incident (case) hierarchies

Added a new topic to describe how incident entities can be related hierarchically. Settings allow an administrator to configure specific behaviors for these relationships.

Integrate SharePoint with Microsoft Dynamics CRM 2013

Updated with information about the new server-based SharePoint Integration for Microsoft Dynamics CRM Online and Microsoft SharePoint Online.

IOrganizationService entities

Added the following topics to describe new entities added for this release:

Enhanced service entities
Entitlement entities
Entitlement entity messages and methods
Entitlement entity privileges
EntitlementChannel entity messages and methods
EntitlementTemplate entity messages and methods
EntitlementTemplate entity privileges
EntitlementTemplateChannel entity messages and methods
RoutingRuleSet entity privileges
SLA (service level agreement) entity privileges
SocialActivity entity messages and methods
SocialActivity entity privileges
SocialProfile entity messages and methods
SocialProfile entity privileges

Open forms, views, dialogs and reports with a URL

Updated the URL Addressable Forms and Views section to include information about new query string parameter arguments you can use to control whether the navigation bar or command bars will be displayed.

Register and use a custom workflow activity assembly

Changed the titles of the PowerShell procedures from “XAML workflows” to “custom code”. The procedures are for enabling/disabling custom code, not XAML workflows.

Retrieve records for many-to-many relationships using intersect entities

Added new relationships for this release.

Run data import

Removed the following sentence: “You must let each job complete successfully before you can submit a new message request for the next asynchronous job.” This isn’t necessary.

Sample: Export ribbon definitions

Updated to include new ribbon-enabled entities.

Sample: Windows 8 desktop modern SOAP app

Updated the app to obtain the OAuth endpoint URL at run time instead of using a hardcoded value.

More information:  Discover the OAuth endpoint URL

Security role UI to privilege mapping

Updated to show mapping of the user interface (UI) for new privileges added in this release.

Social entities

Added a new section to describe social care generic framework and related entities.

Subscribe to SDK assembly updates using NuGet

New information about how to subscribe to the latest or previous SDK assembly releases.

Supported extensions for Microsoft Dynamics CRM 2013

Updated to clarify supported and unsupported extensions.

Types of calendars

New topic describes how the calendar entity has been modified to support additional types of calendars.

Use the Modern app SOAP endpoint for modern applications with web resources

Added the Sample: Sdk.Soap.js library section to introduce the Sdk.Soap.js sample library.

Visual Studio and the .NET Framework

Added information about supported versions of Microsoft Visual Studio and the Developer Toolkit.

Walkthrough: Register an Azure-aware plug-in with the CRM plug-in registration tool

Walkthrough: Register a plug-in using the plug-in registration tool

Walkthrough: Register a CRM app with Active Directory

Analyze plug-in performance

Updated procedures to account for changes in the Plug-in Registration and profiler tools’ user interface. The location of the tool’s executable file has been changed to SDK\Tools\PluginRegistration.

Walkthrough: Register a CRM app with Active Directory

Updated the app registration procedures. All app registration is now done through the Microsoft Azure portal. Graph Explorer is no longer used.

What's changing in the next release

Added a new topic to describe changes that will apply to the next release.

Release History for SDK Version 6.0.4, February 2014

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Microsoft Dynamics CRM 2013 Update Rollup 2. These assemblies are also compatible with the latest service update for Microsoft Dynamics CRM Online.

SDK\Bin\SolutionPackager.exe

Fixed the issue where Solution Packager failed to repack solutions that contain entity level business rules.

Authenticate the user with the web services

Walkthrough: Register a CRM app with Active Directory

Sample: Windows 8 desktop modern SOAP app

Sample: Windows 8 desktop modern OData app

Updated the documentation to include use of Active Directory Federation Services (AD FS) 3.0.

Configure email for incoming messages

SampleCode\CS\BusinessDataModel\BusinessManagement\
ConfigureQueueEmail.cs

SampleCode\VB\BusinessDataModel\BusinessManagement\
ConfigureQueueEmail.vb

Documented deprecated and read-only attribute changes for the email user name and password attributes in the Queue and UserSettings entities.

Changed the sample code, removing the lines of code that set the attributes.

Create a custom workflow activity

Removed support for Microsoft .NET Framework 4.5. Added the requirement to digitally sign the assembly.

Install or uninstall the Developer Toolkit

Added a statement that the Developer Toolkit can’t be installed into the Express edition of Microsoft Visual Studio.

Xrm.Page.ui (client-side reference)

The Xrm.Page.ui.getCurrentControl method is deprecated in Microsoft Dynamics CRM 2013 Update Rollup 2.

Release History for SDK Version 6.0.3, December 2013

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

Microsoft account subscription transition to Office 365

Authenticate Microsoft account users with Office 365

Sample: Authenticate users with Microsoft Dynamics CRM 2013 web services

SampleCode\CS\GeneralProgramming\Authentication\AuthenticateWithNoHelp

Added authentication-related documentation and updated sample code to support the transition of Microsoft account subscriptions to Microsoft Online Services. This applies only to Microsoft Dynamics CRM Online customers.

Release History for SDK Version 6.0.2, December 2013

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Microsoft Dynamics CRM 2013 Update Rollup 1. These assemblies are also compatible with the latest service update for Microsoft Dynamics CRM Online.

Handle exceptions in your code

Added information about how to view the details of an exception that are hidden from the user because of insufficient permissions.

Organization entity attributes

Added topic listing all the attributes that can be set for an organization.

Sample: Set and retrieve entity images

New sample to show how to work with entity images.

Xrm.Page.ui control (client-side reference)

Added information about a new parameter in the setNotification and clearNotification methods. TheuniqueId parameter allows you to clear a specific notification set on a field, based on the uniqueId value used when the notification was set.

Release History for SDK Version 6.0.1, October 2013

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

Actions on entity records

Updated metadata information.

Authenticate the user with the web services

Added OAuth provider URLs.

Command bar or ribbon presentation

Updated the CRM for tablets section to note that icons configured for commands won’t display and labels that are too long will be truncated.

<CrmParameter> (RibbonDiffXml)

Changed description of the SelectedControlSelectedItemReferences attribute to fix an error. This option is only available when used with the <JavaScriptFunction> (RibbonDiffXml) element, not the <Url> (RibbonDiffXml) element.

Dialog limitations

Added information about nested steps.

Form events (client-side reference)

Added a note to the OnLoad Event section saying: Forms for Updated entities don’t reload the page after the initial save creating a record or any subsequent saves. Therefore, the OnLoad event occurs only during the initial load of the form.

Form scripting quick reference

Updated this topic to include examples of new form methods.

Lookup information for the post entity and post follow entity

Explained how to retrieve lookup information for the RegardingObjectId.Target property for the post entity and post follow entity.

Open forms, views, dialogs and reports with a URL

Updated this topic as well as <JavaScriptFunction> (RibbonDiffXml) and <Url> (RibbonDiffXml) to add a note to say that opening entity forms in a dialog window using showModalDialog or showModelessDialog isn’t supported.

In the application, always use Xrm.Utility.openEntityForm instead of window.open to open entity forms.

Model business process flows

Updated information about maximum number of activated business process flows per entity. See section: Maximum number of processes, stages, and steps.

<PageRule> (RibbonDiffXml)

Added remarks to note that this rule can’t be used in Microsoft Dynamics CRM for tablets because it will always refer to one page.

Sample: Windows 8 desktop modern SOAP app
Sample: Windows 8 desktop modern OData app

SampleCode\CS\ModernAndMobileApps

Added new sample applications that show how to write a Windows 8 desktop modern application that can send requests to the organization web service without linking to the SDK assemblies.

Sample: Windows 8 desktop modern SOAP app uses the Microsoft Azure Active Directory Authentication Library (ADAL) and the SOAP protocol.

Sample: Windows 8 desktop modern OData app uses the ADAL and the OData protocol.

<Url> (RibbonDiffXml)

Added a note to this topic saying that it shouldn’t be used to open entity forms. Use <JavaScriptFunction> (RibbonDiffXml) with a function using Xrm.Utility.openEntityForm instead.

Walkthrough: Connect with CRM using Java

Walkthroughs\Java2CRM

Removed sample code and walkthrough. Now that Microsoft Dynamics CRM Online is transitioning from the legacy billing and administration platform to the Microsoft Online Services environment, this sample is no longer relevant. For more information about using CRM Online or CRM 2013 IFD with Java or other non-.NET languages, see the blog post: Use OAuth to authenticate with the CRM service.

Walkthrough: Register a CRM app with Active Directory

Changed the instructions from using the Microsoft Azure portal to using Graph Explorer.

Write and debug scripts for CRM for tablets

Added new topic to consolidate information related to writing scripts for Microsoft Dynamics CRM for tablets.

Write code for Microsoft Dynamics CRM 2013 forms

Added a note to the Different Form Presentations section to say that the collaboration control found in updated entity forms isn’t accessible using form scripts. The section containing the control is available if you want to show or hide the section and the control in it.

Write scripts for composite attributes

Added information to the Composite attributes in the web application section about the naming convention used to access the individual constituent controls displayed in the flyout for composite controls in the web application.

Xrm.Page.ui control (client-side reference)

Updated information in the getAttribute section to note that constituent controls for quick view forms can access the value of an attribute, but any changes to the value of this attribute won’t be saved.

Release History for SDK Version 6.0.0, September 2013

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

Initial version

Start with What's new for developers.

See Also

Software Development Kit for Microsoft Dynamics CRM 2013
What's new for developers