Dynamics CRM Discovery and Web Service URLs

Dynamics CRM Discovery and Web Service URL’s based on the following Dynamics CRM SDK articles.

Discover the URL for your organization with IDiscoveryService web service

Download the endpoints using the Dynamics CRM Developer resources page

Here is the information that you need:

For CRM Online customers:

The following URLs should be used to access the discovery service (use the appropriate URL for your location):

Provider: Microsoft Office 365
https://disco.crm.dynamics.com/XRMServices/2011/Discovery.svc (North America)
https://disco.crm4.dynamics.com/XRMServices/2011/Discovery.svc (EMEA)
https://disco.crm5.dynamics.com/XRMServices/2011/Discovery.svc (APAC)

Provider: Microsoft Account
https://dev.crm.dynamics.com/XRMServices/2011/Discovery.svc (North America)
https://dev.crm4.dynamics.com/XRMServices/2011/Discovery.svc (EMEA)
https://dev.crm5.dynamics.com/XRMServices/2011/Discovery.svc (APAC)

The following URLs should be used to access the Organization service(SOAP endpoint):

https://{Organization Name}.api.crm.dynamics.com/XrmServices/2011/Organization.svc (North America)
https://{Organization Name}.api.crm4.dynamics.com/XrmServices/2011/Organization.svc (EMEA)
https://{Organization Name}.api.crm5.dynamics.com/XrmServices/2011/Organization.svc (APAC)

Where {Organization Name} refers to the Organization that you specify in the URL when accessing the Web application. For example, for Contoso.crm.dynamics.com, the {Organization Name} is Contoso.

The following URLs should be used to access the Organization Data service(OData REST endpoint)

https://{Organization Name}.api.crm.dynamics.com/XrmServices/2011/OrganizationData.svc (North America)
https://{Organization Name}.api.crm4.dynamics.com/XrmServices/2011/OrganizationData.svc (EMEA)
https://{Organization Name}.api.crm5.dynamics.com/XrmServices/2011/OrganizationData.svc (APAC)

For On-premise
deployments:
http://{server}/XRMServices/2011/Discovery.svc for the Discovery service endpoint
http://{server}/{OrgName}/XRMServices/2011/Organization.svc for the Organization Service endpoint (SOAP)
http://{server}/{OrgName}/XRMServices/2011/OrganizationData.svc for the Organization Data Service endpoint (REST)
http://{server}/XRMDeployment/2011/Deployment.svc for the Deployment Service endpoint

For IFD deployments:

http://dev.{hostname[:port]}/XRMServices/2011/Discovery.svc for the Discovery service endpoint

CRM 2011 SDK version 5.0.16 available

The MS CRM Team have released an updated CRM 2011 SDK version 5.0.16 which can be downloaded here http://www.microsoft.com/en-us/download/details.aspx?id=24004 or viewed on MSDN here http://msdn.microsoft.com/en-us/library/gg309408.aspx Check out the SDK Release History notes here http://msdn.microsoft.com/en-us/library/dn198205.aspx

 

What’s Changing in the Next Major Release – This new topic outlines features that will be changing in the upcoming Orion release and provides a tool you can use to help you prepare your organizations for these changes.

 

New and updated topics Description of changes
Microsoft_Dynamics_CRM_2011_SDK_Readme.htm Updated the readme for this version of the SDK package.
Active Directory and Claims-Based Authentication

Authenticate Office 365 Users with Microsoft Dynamics CRM Online Web Services

OrganizationServiceProxy

DiscoveryServiceProxy

Updated these topics to remove the restriction on using the service proxy classes when authenticating with the Microsoft online services identity provider of Microsoft Dynamics CRM Online. You can now use these proxy classes with all deployment types and identity providers.
BulkDeleteRequest

BulkDetectDuplicatesRequest

Added in Remarks that you can run the bulk delete job or bulk detect duplicates job daily or without recurrence.
Create, Export, or Import an Unmanaged Solution

Create, Install, and Update a Managed Solution

Added a note to these topics saying “Installing a solution can interfere with normal system operation. We recommend that you schedule solution imports when it’s least disruptive to users.”
Form XML Reference The following FormXml elements have been updated to indicate that they are for internal use only: <ControlMode> (FormXml), <QuickFormRelationshipName> (FormXML), <QuickFormRelationshipRoleOrdinal> (FormXml), and <UniqueId> (FormXml). These elements are used only in a quick form, which is not customizable. These elements will be removed from the schema in the next major release.
Handle Exceptions in Plug-Ins Clarified how plug-in exceptions are handled and where error message are written or displayed.
Introduction to Activity Feeds Corrected the maximum number of characters in the posts created programmatically. The correct value is 2000 characters.
Introduction to Solutions Added the Enterprise Solution Lifecycle Management section introducing the ALM for Microsoft Dynamics CRM 2011: CRM Solution Lifecycle Management white paper.
Open Forms, Views, Dialogs and Reports with a URL Appended to an existing note to include:

Microsoft Dynamics CRM forms are not designed to be opened as dialogs using either showModalDialog or showModelessDialog.

Uninstall or Delete a Solution Added an Access the Solutions List with a URL section.
What’s Changing in the Next Major Release Added a new topic to provide information about what is changing in the next major release of Microsoft Dynamics CRM.
Write Custom Code for Microsoft Dynamics CRM for Outlook

GoOffline               GoOnline

Added a note that these methods cannot be used in a plug-in because they cause a UI interaction with the user.
Xrm.Page.data.entity Attribute Methods Added a missing getFormat return value: textarea.
Xrm.Page.ui Control Methods Added a remark to the addCustomView method to show that this method does not work with Owner lookups.
Xrm.Utility Reference Corrected an error for the openEntityForm method. This method returns a Boolean value rather than a window object.

CRM 2011 Validate User Security Roles using JavaScript/REST

This example I’m sharing today is demonstrating a few techniques which promote JavaScript and REST, along with using namespaces and creating a library of functions/properties. This example declares a library Security.UserInRole and defines a number of properties and functions. The general idea is to allow the data access via REST to be asynchronous which then offers a valid and invalid function callback option to be defined to handle the outcome. You can specify an array of security roles to check against the current user and then with the callback functions you can perform the actions that you require.

Ideally I want to call a function that is easy to use and it will look like this.
Security.UserInRole.checkUserInRole(
["System Administrator", "System Customizer", "Custom Role Name"],
function(){alert("valid"); // The user is in one of the specifed roles.
},
function(){alert("invalid"); // The user is not in one of the specifed roles.
}
}

To define the library namespace and object we use
//If the Security namespace object is not defined, create it.
if (typeof (Security) == "undefined")
{ Security = {}; }
// Create Namespace container for functions in this library;
if (typeof (Security.UserInRole) == "undefined") {
Security.UserInRole = {
__namespace: true
};
}

 

The library functions and properties declared include the following
Security.UserInRole = {
isInRole: null,
roleIdValues: [],
validFunction: null,
invalidFunction: null,
checkRoles: [],
checkUserInRole: function (roles, validFunc, invalidFunc) {},
getAllowedSecurityRoleIds: function () {},
validateSecurityRoles: function () {},
querySecurityRoles: function (queryString) {},
__namespace: true
};

 

The entire library is implemented so that you call a function, it performs the processing asynchronously and then gives you the outcome to handle the response. Whether you want to show/hide form elements or disable fields etc, you can handle this in the callback function parameters validFunc and invalidFunc defined in the checkUserInRole function. The entire library content can be placed in a CRM webresource and added to a form. The full library is as shown below.

//If the Security namespace object is not defined, create it.
if (typeof (Security) == "undefined")
{ Security = {}; }
// Create Namespace container for functions in this library;
if (typeof (Security.UserInRole) == "undefined") {
Security.UserInRole = {
isInRole: null,
roleIdValues: [],
validFunction: null,
invalidFunction: null,
checkRoles: [],
checkUserInRole: function (roles, validFunc, invalidFunc) {
validFunction = validFunc;
invalidFunction = invalidFunc;
checkRoles = roles;
Security.UserInRole.getAllowedSecurityRoleIds();
},
getAllowedSecurityRoleIds: function () {
var filter = "";
for (var i = 0; i < checkRoles.length; i++) {
if(filter == "") {
filter = "Name eq '" + checkRoles[i] + "'";
}
else {
filter += " or Name eq '" + checkRoles[i] + "'";
}
}
Security.UserInRole.querySecurityRoles("?$select=RoleId,Name&$filter=" + filter);
},
validateSecurityRoles: function () {
switch (Security.UserInRole.isInRole) {
//If the user has already been discovered in role then call validFunc
case true:
validFunction.apply(this, []);
break;
default:
var userRoles = Xrm.Page.context.getUserRoles();
for (var i = 0; i < userRoles.length; i++) {
var userRole = userRoles[i];
for (var n = 0; n < Security.UserInRole.roleIdValues.length; n++) {
var role = Security.UserInRole.roleIdValues[n];
if (userRole.toLowerCase() == role.toLowerCase()) {
Security.UserInRole.isInRole = true;
// Call function when role match found
validFunction.apply(this, []);
return true;
}
}
}
// Call function when no match found
invalidFunction.apply(this, []);
break;
}
},
querySecurityRoles: function (queryString) {
var req = new XMLHttpRequest();
var url = "";
// Try getClientUrl first (available post Rollup 12)
if (Xrm.Page.context.getClientUrl) {
url = Xrm.Page.context.getClientUrl();
}
else {
url = Xrm.Page.context.getServerUrl();
}
req.open("GET", url + "/XRMServices/2011/OrganizationData.svc/RoleSet" + queryString, true);
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.onreadystatechange = function () {
if (this.readyState == 4 /* complete */) {
req.onreadystatechange = null; //Addresses memory leak issue with IE.
if (this.status == 200) {
var returned = window.JSON.parse(this.responseText).d;
for (var i = 0; i < returned.results.length; i++) {
Security.UserInRole.roleIdValues.push(returned.results[i].RoleId);
}
if (returned.__next != null) {
//In case more than 50 results are returned.
// This will occur if an organization has more than 16 business units
var queryOptions = returned.__next.substring((url + "/XRMServices/2011/OrganizationData.svc/RoleSet").length);
Security.UserInRole.querySecurityRoles(queryOptions);
}
else {
//Now that the roles have been retrieved, try again.
Security.UserInRole.validateSecurityRoles();
}
}
else {
var errorText;
if (this.status == 12029)
{ errorText = "The attempt to connect to the server failed."; }
if (this.status == 12007)
{ errorText = "The server name could not be resolved."; }
try {
errorText = window.JSON.parse(this.responseText).error.message.value;
}
catch (e)
{ errorText = this.responseText }
}
}
};
req.send();
},
__namespace: true
};
}

 

To use the library in the onload event of an entity form simply add the Security.UserInRole library webresource to the form and create a another JavaScript web resource to hold the onload function. The onload function may look like this. You define the roles to check as an array and pass this to the checkUserInRole function along with the valid and invalid callback functions. You don’t have to define the functions as anonymous functions like my example below but it can sometimes feel cleaner.

function onload()
{
Security.UserInRole.checkUserInRole(
["System Administrator", "System Customizer", "Custom Role Name"],
function(){alert("valid"); // The user is in one of the specifed roles.
},
function(){alert("invalid"); // The user is not in one of the specifed roles.
}
);
}

 

I would like to mention Jim Daly from the MS CRM Team for his examples of namespace and library structure along with his REST query code as this example I have created is derived from his outstanding work.

Happy Coding..

CRM 2011 SDK version 5.0.13 available

The MS CRM Team have released an updated CRM 2011 SDK version 5.0.13 which can be downloaded here http://www.microsoft.com/en-us/download/details.aspx?id=24004 or viewed on MSDN here http://msdn.microsoft.com/en-us/library/gg309408.aspx Check out the release notes here http://msdn.microsoft.com/en-us/library/jj863620.aspx

Quick Overview

  • Custom workflow activities can now be registered in the sandbox and are supported by Microsoft Dynamics CRM Online.
  • The Developer Toolkit for Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online now supports Microsoft Visual Studio 2012.
  • 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.
  • Updated the metadata browser to version 2.0
  • Added a new topic for the new metadata query capabilities included in the Microsoft.Xrm.Sdk.Metadata.Query namespace.
  • Updated the topic to include information related to support for browsers other than Internet Explorer.
  • 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.
  • Updated exported ribbon definitions for Microsoft Dynamics CRM 2011
  • Added support for the Microsoft online services environment to connect to Microsoft Office 365.
  • 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.
  • 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.
  • Added new and updated information about using Windows Azure with Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online.
  • 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.
  • Updated these samples to build with newer versions of the Windows Azure SDK, version 1.7 or 1.8.
  • A bunch of sdk samples have been added and others updated.

Prepare for Dynamics CRM Rollup 12

Are you ready for the multi browser support of your customisations with Dynamics CRM Rollup 12, do you even care? It sounds great doesn’t it, IE, Chrome, Safari, Firefox, take your pick but will your CRM script customisations be supported. I guarantee this is the number one question facing CRM implementers/developers/testers right now and hopefully most have had a chance to test against the latest build of Rollup 12.

If you are a single browser environment and it remains as IE then you may be feeling comfortable but I recommend you follow-up with some testing and review time before applying Rollup 12.

There are some key areas that need looking at and you can find a list of impacted areas here

Resolve Breaking Script Issues When Upgrading Microsoft Dynamics CRM

 

To aid in the validation there is a tool available from Microsoft called the Microsoft Dynamics CRM 2011 Custom Code Validation Tool  which helps to identify potential issues with custom JavaScript in JavaScript libraries and HTML web resources.

To see an overview of problem areas you can see the release blog regarding the validation tool which highlights and lists the various potential issues that have been identified.

Microsoft Dynamics CRM 2011 Custom Code Validation Tool Released

 

The biggest threat to some may be the support of CRM 4 client side script or the lack there of as this becomes obsolete and unsupportable as CRM moves forward.

In many cases business requirements come first and in a perfect world we would never need to venture outside of the CRM 2011 client API so the main thought here should be before implementing unsupported customisations ask yourself if there is an alternative option to avoid future pain.

Don’t forget to check out the latest SDK when its available and read through the documentation covering this as it’s fairly complete and highly detailed for our needs.

CRM 2011 SDK version 5.0.12 available

The MS CRM Team have released an updated CRM 2011 SDK version 5.0.12 which can be downloaded here http://www.microsoft.com/en-us/download/details.aspx?id=24004 or viewed on MSDN here http://msdn.microsoft.com/en-us/library/gg309408.aspx Check out the release notes here http://msdn.microsoft.com/en-us/library/hh547453.aspx#bkmk_ReleaseHistory

In Summary the update contains

  • Updated assemblies for Microsoft Dynamics CRM 2011 Update Rollup 10. http://www.microsoft.com/en-gb/download/details.aspx?id=30711
  • A new Form Scripting Quick Reference that provides simple explanations and examples of the Xrm.Page object methods on a single page. http://msdn.microsoft.com/en-us/library/jj602964
  • A new topic called Choose your Development Style for Managed Code that describes the choices of tools and classes you can use when you write managed code and provides information to help you decide what is best for your needs.
  • A new topic called Create Accessible Web Resources that provides an introduction to creating web resources that offer equivalent functionality for all users so that people with disabilities will be able to use your web resources. http://technet.microsoft.com/en-us/library/jj602917.aspx
  • Improved authentication helper code and a new sample that demonstrates how to connect to the web services without using helper code.
  • Code changes to work in browsers to be supported in a later release, and information to guide you in making those changes.
  • Delivered the Solution Packaging Tool!
  • And much more… read the Release History for complete details. http://msdn.microsoft.com/en-us/library/hh547453.aspx#bkmk_ReleaseHistory

CRM 2011 SDK version 5.0.9 available

The MS CRM Team have released an updated CRM 2011 SDK version 5.0.9 which can be downloaded here http://www.microsoft.com/download/en/details.aspx?id=24004 or viewed on MSDN here http://msdn.microsoft.com/en-us/library/gg309408.aspx Check out the release notes here http://msdn.microsoft.com/en-us/library/hh547453.aspx#bkmk_ReleaseHistory

In Summary the update contains

  • Updated assemblies for Microsoft Dynamics CRM 2011 Update Rollup 6 and the Microsoft Portal developer toolkit and developer extensions.
  • Information about creating localized dialog processes.
  • New samples that authenticate the user with the web services without using the helper code
  • New topic to help developers find information about using JavaScript with various features that support it.

CRM 2011 SDK version 5.0.8 available

The MS CRM Team have released an updated CRM 2011 SDK version 5.0.8 which can be downloaded here http://www.microsoft.com/download/en/details.aspx?id=24004 or viewed on MSDN here http://msdn.microsoft.com/en-us/library/gg309408.aspx

Check out the release notes here http://msdn.microsoft.com/en-us/library/hh547453.aspx#bkmk_ReleaseHistory

Updated CRM 2011 Download Links

Here is an updated list of available CRM 2011 RTM downloads. It is good practice to have these files on a portable drive but it’s also recommended to have an updated list of download links.

Component URL
Server http://www.microsoft.com/download/en/details.aspx?id=27822
Outlook Client http://www.microsoft.com/download/en/details.aspx?id=27821
Language Pack http://www.microsoft.com/download/en/details.aspx?id=27819
Email Router http://www.microsoft.com/download/en/details.aspx?id=27818
Report Extension http://www.microsoft.com/download/en/details.aspx?id=27823
SharePoint List http://www.microsoft.com/download/en/details.aspx?id=5283
Software Development Kit http://www.microsoft.com/download/en/details.aspx?id=24004
Implementation Guide along with additiional Planning Tools http://www.microsoft.com/download/en/details.aspx?id=3621