Friday, December 16, 2011

Check the License Type for a Deployment of Microsoft Dynamics CRM 2011 Using .NET or Jscript

This illustration shows how to check the license type for a deployment of Microsoft Dynamics CRM 2011 with RetrieveDeploymentLicenseTypeRequest.  This example will be given in Jscript (SOAP) and in C# (.NET).

Important Note: The LicenseType property included in the response returns a guid.  After not having a lot of luck searching for how to figure out what that meant I searched for the guid itself and got one hit and found that the same guids were used for 4.0 versions also. Here are the guids I know about.  I personally checked my enterprise server and online environments and verified that they did indeed return these exact guids.

  • SmallBusiness 9436EA66-8262-4168-9B6C-21DF47D1D121
  • Professional 5BEEA2E8-8F82-40e8-AE0F-6D8C135E1397
  • Enterprise CB96BDD5-5F74-4ea5-8323-9D7E20079002
  • Live 66AE2919-DD58-40ca-A980-AEF7330B2745
  • SPLA (Service Provider) 722E9E15-62DC-48a7-95CF-93131BE27273
    Ok, here is what the code looks like!
    First in C#:

    RetrieveDeploymentLicenseTypeRequest req = new RetrieveDeploymentLicenseTypeRequest();
    RetrieveDeploymentLicenseTypeResponse resp = (RetrieveDeploymentLicenseTypeResponse)service.Execute(req);

    If you need help instantiating a service object in .NET within a plugin check out this post:

    Now here is the Jscript nicely formatted by the CRM 2011 SOAP formatter. Available at:

    Now in Jscript

    This example is asynchronous, if you want to learn how to make JScript SOAP calls synchronously please visit this post

    if (typeof (SDK) == "undefined")
       { SDK = { __namespace: true }; }
           //This will establish a more unique namespace for functions in this library. This will reduce the 
           // potential for functions to be overwritten due to a duplicate name when the library is loaded.
           SDK.SAMPLES = {
               _getServerUrl: function () {
                   /// Returns the URL for the SOAP endpoint using the context information available in the form
                   /// or HTML Web resource.
                   var ServicePath = "/XRMServices/2011/Organization.svc/web";
                   var serverUrl = "";
                   if (typeof GetGlobalContext == "function") {
                       var context = GetGlobalContext();
                       serverUrl = context.getServerUrl();
                   else {
                       if (typeof Xrm.Page.context == "object") {
                             serverUrl = Xrm.Page.context.getServerUrl();
                       { throw new Error("Unable to access the server URL"); }
                      if (serverUrl.match(/\/$/)) {
                           serverUrl = serverUrl.substring(0, serverUrl.length - 1);
                       return serverUrl + ServicePath;
               RetrieveDeploymentLicenseTypeRequest: function () {
                   var requestMain = ""
                   requestMain += "<s:Envelope xmlns:s=\"\">";
                   requestMain += "  <s:Body>";
                   requestMain += "    <Execute xmlns=\"\" xmlns:i=\"\">";
                   requestMain += "      <request i:type=\"b:RetrieveDeploymentLicenseTypeRequest\" xmlns:a=\"\" xmlns:b=\"\">";
                   requestMain += "        <a:Parameters xmlns:c=\"\" />";
                   requestMain += "        <a:RequestId i:nil=\"true\" />";
                   requestMain += "        <a:RequestName>RetrieveDeploymentLicenseType</a:RequestName>";
                   requestMain += "      </request>";
                   requestMain += "    </Execute>";
                   requestMain += "  </s:Body>";
                   requestMain += "</s:Envelope>";
                   var req = new XMLHttpRequest();
         "POST", SDK.SAMPLES._getServerUrl(), true)
                   req.setRequestHeader("Accept", "application/xml, text/xml, */*");
                   req.setRequestHeader("Content-Type", "text/xml; charset=utf-8");
                   req.setRequestHeader("SOAPAction", "");
                   var successCallback = null;
                   var errorCallback = null;
                   req.onreadystatechange = function () { SDK.SAMPLES.RetrieveDeploymentLicenseTypeResponse(req, successCallback, errorCallback); };
           RetrieveDeploymentLicenseTypeResponse: function (req, successCallback, errorCallback) {
                   /// Recieves the assign response
                   ///<param name="req" Type="XMLHttpRequest">
                   /// The XMLHttpRequest response
                   ///<param name="successCallback" Type="Function">
                   /// The function to perform when an successfult response is returned.
                   /// For this message no data is returned so a success callback is not really necessary.
                   ///<param name="errorCallback" Type="Function">
                   /// The function to perform when an error is returned.
                   /// This function accepts a JScript error returned by the _getError function
                   if (req.readyState == 4) {
                   if (req.status == 200) {
                   if (successCallback != null)
                   { successCallback(); }
                   else {
           _getError: function (faultXml) {
               /// Parses the WCF fault returned in the event of an error.
               ///<param name="faultXml" Type="XML">
               /// The responseXML property of the XMLHttpRequest response.
               var errorMessage = "Unknown Error (Unable to parse the fault)";
               if (typeof faultXml == "object") {
                   try {
                       var bodyNode = faultXml.firstChild.firstChild;
                       //Retrieve the fault node
                       for (var i = 0; i < bodyNode.childNodes.length; i++) {
                           var node = bodyNode.childNodes[i];
                           //NOTE: This comparison does not handle the case where the XML namespace changes
                           if ("s:Fault" == node.nodeName) {
                           for (var j = 0; j < node.childNodes.length; j++) {
                               var faultStringNode = node.childNodes[j];
                               if ("faultstring" == faultStringNode.nodeName) {
                                   errorMessage = faultStringNode.text;
               catch (e) { };
            return new Error(errorMessage);
     __namespace: true

    To understand how to parse the response please review my post on using the DOM parser.
    Now you can call the SDK.SAMPLES.RetrieveDeploymentLicenseTypeRequest function from your form jscript handler.

    Thats all there is to it!

    No comments:

    Post a Comment