Saturday, March 12, 2011

Publish an Entity in Jscript in Microsoft Dynamics CRM 2011

If you work with the metadata messages of the CRM 2011 OrganizationService in Jscript I can see how it would be useful to have the ability to publish an entity in Jscript.  So here is how you do it.

The only thing you need to change in the code below is the word account to whatever entity you want to publish in the annotated line.  You might also want to do a find/replace on the word account if you change it to a different entity so your code isn't confusing to other people because you are publishing the contact entity with a PublishAccountRequest function.

The function within this library can then by called by adding the following command reference to an eventhandler on a form in CRM.

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


When copied from here and pasted elsewhere, the code looks a lot better. 

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.PUBLISH = {
           _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;
           PublishAccountRequest: function () {
               var requestMain = ""
               requestMain += "<s:Envelope xmlns:s=\"\">";
               requestMain += "  <s:Body>";
               requestMain += "    <Execute xmlns=\"\" xmlns:i=\"\">";
               requestMain += "      <request i:type=\"b:PublishXmlRequest\" xmlns:a=\"\" xmlns:b=\"\">";
               requestMain += "        <a:Parameters xmlns:c=\"\">";
               requestMain += "          <a:KeyValuePairOfstringanyType>";
               requestMain += "            <c:key>ParameterXml</c:key>";
               // ONE STEP SCRIPT CONFIGURATION: The Line below contains the word "account", you can change this name to whatever entity you want to publish
               requestMain += "            <c:value i:type=\"d:string\" xmlns:d=\"\">&lt;importexportxml&gt;&lt;entities&gt;&lt;entity&gt;account&lt;/entity&gt;&lt;/entities&gt;&lt;/importexportxml&gt;</c:value>";
               requestMain += "          </a:KeyValuePairOfstringanyType>";
               requestMain += "        </a:Parameters>";
               requestMain += "        <a:RequestId i:nil=\"true\" />";
               requestMain += "        <a:RequestName>PublishXml</a:RequestName>";
               requestMain += "      </request>";
               requestMain += "    </Execute>";
               requestMain += "  </s:Body>";
               requestMain += "</s:Envelope>";
               var req = new XMLHttpRequest();
     "POST", SDK.PUBLISH._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.PUBLISH.PublishAccountResponse(req, successCallback, errorCallback); };
       PublishAccountResponse: 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

Have a great weekend and check back soon,  I have some big surprises coming up in the near future in this series of Jscript CRM 2011 posts.

No comments:

Post a Comment