Friday, 10 February 2012

CRM 2011: Launch a Dialog on click of custom ribbon button located at homepage grid (landing page) of an entity

In my previous post, I have explained how to launch a dialog on click of ribbon button located at entity form. Here, in this post I am going to describe how to open a dialog on click of ribbon button located at homepage grid (landing page) of an entity.

In this Example, I’ve used custom entity “Flight Route” contains a button called “Test Button” which will launch a dialog. Dialog will select a flight name from the option set and insert new note record on the selected flight route record.

Following are steps that demonstrate launch dialog from ribbon button.

Before to start with a launch dialog, we need to create
1. Create a dialog for “Flight Route” entity
· Select Solution.
· Select Processes.
· Create new process.


· Specify the Process name.
· Select Entity.
· Select “Activate as” as “Process” and “Category” as “Dialog”.
· Configure it as an on-demand process.
· For this dialog make sure that it should contain at least one “Prompt and Response”

2. Javascript Library as a web resource
· Create new Web resource” /javascripts/LaunchModalDialog.js”

· Click on Text Editor.
· Insert below functions in Text editor window.
   1: function LaunchModalDialog(dialogId,typeName,recordId)
   2: {
   3:     recordId = recordId.toString();    
   4:     recordId =recordId.replace("{", "");        
   5:     recordId =recordId.replace("}", "");
   7:     dialogId=dialogId.replace("{", "");
   8:     dialogId=dialogId.replace("}", "");
  10:     var serverUrl = getServerUrl();
  11:     // Load modal
  12:     var serverUri = serverUrl +'/cs/dialog/rundialog.aspx';
  14:     var mypath =  serverUri +'?DialogId=%7b' +dialogId.toUpperCase()  +'%7d&EntityName=' + typeName+'&ObjectId=%7b' +recordId+'%7d';
  16:     // First item from selected contacts only
  17:     window.showModalDialog(mypath);
  19:     // Reload form.
  20:     window.location.reload(true);
  21: }

In above JavaScript method I have used 3 different parameters.

dialogId is id of the dialog we need to open from button (String Parameter)
typeName is entity’s logical name (CRM Parameter)
recordId is entity’s current record id form where the dialog will be launched(CRM Parameter).

   1: function getServerUrl()
   2: {
   3:     // Generate the URL schema using a basic check for SSL
   4:     var url = 'http' + (WEB_SERVER_PORT == 443 ? 's' : '') + '://';
   6:     if (IS_SPLA)
   7:     {
   8:         // Add the Organisation name in the IFD format 
   9:         url += ORG_UNIQUE_NAME + '.';
  10:     }
  12:     // Append the web server host
  13:     url += WEB_SERVER_HOST;
  15:     // Add your custom URL suffix
  16:     //url += ''
  18:     if (WEB_SERVER_PORT != 80 && WEB_SERVER_PORT != 443)
  19:     {
  20:         // Add the port if it is not standard HTTP or HTTPS
  21:         url += ':' + WEB_SERVER_PORT;
  22:     }
  24:     if (IS_ONPREMISE)
  25:     {
  26:         // Add the on-premise organisation name
  27:         url += '/' + ORG_UNIQUE_NAME;
  28:     }
  30:     // Return the URL
  31:     return url;
  32: }

The above function will create server URL according to the CRM configuration. This takes into account IFD and On-premise environments. You can modify or simplify this as needed.

3. Get the Dialog Id Value

· Once you have created new dialog.
· Click Start Dialog.


· That will open new dialog window.
· Get the dialog id value from the URL(Ctrl+N) and note it down somewhere for future use .


4. Insert custom button on entity’s Homepage (landing page) using Visual Ribbon Editor. ( To create a new button on ribbon, you can refer below link---)

5. After inserting a new custom button, follow the below steps to add javascript function with parameters

· Click on Add link for specifying the “Function name” and “Library”

         a. Specify function name and library name.
         b. Click on “Add” link as shown below. It will open a list of parameter types which you can pass
             with the function.


As discussed earlier (refer step 2) we need 3 different parameters to call JavaScript method. Pass those values as described below. The first parameter will be the value which we have noted in step 3. The second one is entity name. And the last one is the record GUID.


· Now you can set Enable Rule for this button.
· Click on “Add” link and select “SelectionCountRule” in “Enable Rules” as shown below.


· Specify the require details as shown below.


Due to above Rule user cannot select more than one record to launch a dialog. By default this custom ribbon button will be disabled. Once you select a record it gets enabled. Also, while user selects more than 1 record, this button gets disabled.

· Clicks on save. It will save and publish the changes on CRM server.

6. Now you can verify the button on your entity’s Homepage ribbon.


7. On click of this button your dialog will be launched.


8. Select Flight Name from the list and click next and then Finish on the last screen.


9. At the end, a note will be generated on Flight Route entity



  1. Fantastic post and it worked like a charm for me! As a result we have a very excited and happy customer!

    Many thanks!

  2. This comment has been removed by the author.

  3. Ankit, it is very useful and helped me so much. As a new comer to CRM, your help and knowledge very much helpful to me. If you don't mind can you drop me a mail to

    Many thanks and may god provide you more useful knowledge.

    may god bless you

    Abdul rahman

  4. Hello Abdul,

    Thank you for your blessing on me.

    You can reach out to me at

  5. Thank you for this post. I am calling a Javascript that reads data from the record. It is working when clicking the button from the form, but not from the Homepage. Do you have any suggestions?

  6. Hello Terri,

    It should work.

    Could you please share your code?