Monday, July 11, 2011

Export Solution from Microsoft Dynamics CRM 2011 Using .NET or Jscript With ExportSolutionRequest

This illustration shows how to export a solution in Microsoft Dynamics CRM 2011 in code in jscript and also C#  using the Export Solution Request.   This example will be given in SOAP (JScript) and in C# (.NET).  In Jscript you can get the file but it is trickier to write it out as it is returned to the response as a base 64 encoded binary file.  Security restrictions on web applications may disallow directly saving the file to the client hard disk when performing this operation in JScript.

Ok, here is what the code look like!
First in C#:

//Export a solution
String outputDir = @"C:\code\";

ExportSolutionRequest exportSolutionRequest = new ExportSolutionRequest();
exportSolutionRequest.Managed = false;

//Specify the unique name of your solution
exportSolutionRequest.SolutionName = "TestSolution";

ExportSolutionResponse exportSolutionResponse = (ExportSolutionResponse)service.Execute(exportSolutionRequest);

byte[] exportXml = exportSolutionResponse.ExportSolutionFile;
string filename = "TestSolution" + ".zip";
File.WriteAllBytes(outputDir + filename, exportXml);

Console.WriteLine("Solution exported to {0}.", outputDir + filename);

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 is 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 OrgServicePath = "/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 + OrgServicePath;
           ExportSolutionRequest: function () {
               var requestMain = ""
               requestMain += "<s:Envelope xmlns:s=\"\">";
               requestMain += "  <s:Body>";
               requestMain += "    <Execute xmlns=\"\" xmlns:i=\"\">";
               requestMain += "      <request i:type=\"b:ExportSolutionRequest\" xmlns:a=\"\" xmlns:b=\"\">";
               requestMain += "        <a:Parameters xmlns:c=\"\">";
               requestMain += "          <a:KeyValuePairOfstringanyType>";
               requestMain += "            <c:key>SolutionName</c:key>";
               requestMain += "            <c:value i:type=\"d:string\" xmlns:d=\"\">TestSolution</c:value>";
               requestMain += "          </a:KeyValuePairOfstringanyType>";
               requestMain += "          <a:KeyValuePairOfstringanyType>";
               requestMain += "            <c:key>Managed</c:key>";
               requestMain += "            <c:value i:type=\"d:boolean\" xmlns:d=\"\">false</c:value>";
               requestMain += "          </a:KeyValuePairOfstringanyType>";
               requestMain += "        </a:Parameters>";
               requestMain += "        <a:RequestId i:nil=\"true\" />";
               requestMain += "        <a:RequestName>ExportSolution</a:RequestName>";
               requestMain += "      </request>";
               requestMain += "    </Execute>";
               requestMain += "  </s:Body>";
               requestMain += "</s:Envelope>";
               var req = new XMLHttpRequest();
     "POST", SDK.SAMPLES._getServerUrl(), true)
               // Responses will return XML. It isn't possible to return JSON.
               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.ExportSolutionResponse(req, successCallback, errorCallback); };
       ExportSolutionResponse: 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.ExportSolutionRequest function from your form jscript handler.
Thats all there is to it!

I hope this helps!


  1. It's a zip file, like you get when you export a solution through the UI. It's base-64 encoded when it comes back in response, but that's easy to decode in either jscript or .NET.

  2. If i want to Export Complete Customization (Default), will this code work ???