Ribbon Customization Part 12:Custom Ribbon Tab in CRM is now always selected

Usually when we add a custom tab to the HomePageGrid as discussed in the post  , it will add the custom tab but when navigate to different entities , All the times, Custom Tab is selected, in order to avoid that we need add the below TabDisplayRule

<TabDisplayRules>

     <TabDisplayRule TabCommand="Mscrm.Isv.Global">

          <EntityRule Context ="HomePageGrid" AppliesTo ="SelectedEntity"/>

      </TabDisplayRule>

</TabDisplayRules>

 

That’s it.,by this You can avoid the default selection of the custom Tab all the times.

Ribbon Customization Part 11:Enable,Disable Ribbon button based on Security Role

After  a small gap I am blogging again, as I have there  there is a requirement for the ribbon controls to he shown depending on the security role.

So in this post I am  going to show a  custom button, in the Case homepage grid  under the Actions group. and I will make this button to be enabled only when the user with the “System Admin”role has logged in and I don’t enable this button for the rest of the users. << and also this button has the functionality for the Resolve Case>>

Steps to follow

1. Create a solution
2. Add  the entity ‘case’
3. Add a Javascript webresource with the following code and named as ‘CommonLibrabry’

function UserHasRole(roleName) {

    var serverUrl = Xrm.Page.context.getServerUrl();

    var oDataEndpointUrl = serverUrl + "/XRMServices/2011/OrganizationData.svc/";

    oDataEndpointUrl += "RoleSet?$top=1&$filter=Name eq '" + roleName + "'";

    var service = GetRequestObject();

    if (service != null) {

        service.open("GET", oDataEndpointUrl, false);

        service.setRequestHeader("X-Requested-Width", "XMLHttpRequest");

        service.setRequestHeader("Accept", "application/json, text/javascript, */*");

        service.send(null);

        var requestResults = eval('(' + service.responseText + ')').d;

        if (requestResults != null && requestResults.results.length == 1) {

            var role = requestResults.results[0]; 

            var id = role.RoleId;

            var currentUserRoles = Xrm.Page.context.getUserRoles();

            for (var i = 0; i < currentUserRoles.length; i++) {

                var userRole = currentUserRoles[i];

                if (GuidsAreEqual(userRole, id)) {

                    return true;

                }

            }

        }

    }

    return false;

}

function GetRequestObject() {

    if (window.XMLHttpRequest) {

        return new window.XMLHttpRequest;

    }

    else {

        try {

            return new ActiveXObject("MSXML2.XMLHTTP.3.0");

        }

        catch (ex) {

            return null;

        }

    }

}

function GuidsAreEqual(guid1, guid2) {

    var isEqual = false;

    if (guid1 == null || guid2 == null) {

        isEqual = false;

    }

    else {

        isEqual = guid1.replace(/[{}]/g, "").toLowerCase() == guid2.replace(/[{}]/g, "").toLowerCase();

    }

    return isEqual;

}

function callMain() {

if(UserHasRole("System Administrator"))

{

return true;

}

else 

{

return false;

}

}

4. Export the solution
5. Unzip the solution
6. Edit the customization
7. Add the below custom action to display the button under the –Actions Group in the HomepageGrid

<CustomAction Id ="sample.HomepageGrid.incident.MainTab.Actions.CustomAction" 

Location ="Mscrm.HomepageGrid.incident.MainTab.Actions.Controls._children" 

                       Sequence ="10">

          <CommandUIDefinition>           

              <Button Id="sample.HomepageGrid.incident.MainTab.Actions.Button"

                      Command="sample.HomepageGrid.incident.MainTab.Actions.Command"

                      LabelText="$LocLabels:sample.HomepageGrid.incident.MainTab.Actions.LabelText"

                      ToolTipTitle="$LocLabels:sample.HomepageGrid.incident.MainTab.Actions.LabelText"

                      ToolTipDescription="$LocLabels:sample.HomepageGrid.incident.MainTab.Actions.ToolTip"

                      TemplateAlias="o1"

                      Image16by16="/_imgs/ribbon/AddEmail_16.png"

                      Image32by32="/_imgs/ribbon/Email_32.png" />             

          </CommandUIDefinition>         

        </CustomAction>

8. Define the command definition., basically this button has the functionality of << Resolving a case>>
1. this will enable when only one record is selected in the Grid and also if the user has the ‘System Administrator” Role

<CommandDefinition Id="sample.HomepageGrid.incident.MainTab.Actions.Command">

           <EnableRules>

             <EnableRule Id="Mscrm.CustomcheckRole" />

             <EnableRule Id="Mscrm.SelectionCountExactlyOne" />             

             <EnableRule Id="Mscrm.VisualizationPaneNotMaximized" />

           </EnableRules>

           <DisplayRules>

             <DisplayRule Id="Mscrm.CanChangeIncidentForm" />

           </DisplayRules>

           <Actions>

             <JavaScriptFunction FunctionName="Mscrm.IncidentActions.resolveCase" Library="/_static/_common/scripts/ribbonactions.js">

               <CrmParameter Value="FirstSelectedItemId" />

               <CrmParameter Value="SelectedControl" />

             </JavaScriptFunction>

           </Actions>

         </CommandDefinition>

9. Provide the appropriate Display rule as well as the Enable rules as shown below

<DisplayRules>

           <DisplayRule Id="Mscrm.CanChangeIncidentForm">

             <EntityPrivilegeRule EntityName="incident" PrivilegeType="Write" PrivilegeDepth="Basic" />

             <EntityPrivilegeRule EntityName="incident" PrivilegeType="AppendTo" PrivilegeDepth="Basic" />

             <EntityPrivilegeRule EntityName="activitypointer" PrivilegeType="Create" PrivilegeDepth="Basic" />

             <EntityPrivilegeRule EntityName="activitypointer" PrivilegeType="Append" PrivilegeDepth="Basic" />

           </DisplayRule>            

         </DisplayRules>

         <EnableRules>

           <EnableRule Id="Mscrm.SelectionCountExactlyOne">

             <SelectionCountRule Minimum="1" Maximum="1" AppliesTo="SelectedEntity" />

           </EnableRule>

           <EnableRule Id="Mscrm.VisualizationPaneNotMaximized">

             <CustomRule FunctionName="Mscrm.RibbonActions.disableButtonsWhenChartMaximized"

         Library="/_static/_common/scripts/RibbonActions.js">

               <CrmParameter Value="SelectedControl" />

             </CustomRule>

           </EnableRule>

           <EnableRule Id="Mscrm.CustomcheckRole">

             <CustomRule FunctionName="callMain"

 Library="$webresource:new_CommonLibrary">

             </CustomRule>

           </EnableRule>

         </EnableRules>

10. Provide the locales as shown below

<LocLabels>

         <LocLabel Id="sample.HomepageGrid.incident.MainTab.Actions.LabelText">

           <Titles>

             <Title languagecode="1033"

                     description="Custom Button1" />

           </Titles>

         </LocLabel>

         <LocLabel Id="sample.HomepageGrid.incident.MainTab.Actions.ToolTip">

           <Titles>

             <Title languagecode="1033"

                     description="Custom Button1" />

           </Titles>

         </LocLabel>

       </LocLabels>

11. The screenshot appears as  shown below. when I logged with a user having system Admin role
12. 
13. The screenshot appears as  shown below. when I logged with a user who doesn’t have system Admin role
14. 
15. The entire source code can be downloaded from here
16. Happy learning

Dynamics CRM 2011 Ribbon Customization Index

Here I am listing the index for my posts For Ribbon Customization

Topic	Link
Understanding the CRM 2011 Ribbon	https://dynamicscrm2011.wordpress.com/2011/04/05/ribbon-customization/
Adding a Custom Tab to the CRM 2011 ribbon ( for HomePageGrid., and this will display for all the entities—like a Custom ISV Tab)	https://dynamicscrm2011.wordpress.com/2011/04/12/ms-dynamics-crm-2011-ribbon-customization-part-i-add-a-custom-tab-to-microsoft-dynamics-crm-2011-ribbon/
Understanding the Ribbon Customization-Schemas of the Ribbon	https://dynamicscrm2011.wordpress.com/2011/04/12/ms-dynamics-crm-2011-ribbon-customization-part-2-understanding-the-ribbon-customization/
Adding a Custom Tab to the Specific Entity ( i.e for opportunity entity)	https://dynamicscrm2011.wordpress.com/2011/04/13/ribbon-customization-part-3-add-a-custom-tab-to-a-specific-entityopportunity-entity/
Adding a Custom Tab, Custom Group,Button to the Grid Ribbon of a specific entity (i.e for Opportunity Entity)	https://dynamicscrm2011.wordpress.com/2011/04/27/ribbon-customization-part-4-add-a-custom-tab-custom-group-and-custom-buttons-to-a-specific-entityopportunity-entity/
Adding a Custom Tab, Custom Group,Button to the Form Ribbon and SubGrid Ribbon of a specific entity (i.e for Opportunity Entity)	https://dynamicscrm2011.wordpress.com/2011/04/27/ribbon-customization-part-5-add-a-custom-tab-custom-group-and-custom-buttons-to-a-form-ribbon-for-a-specific-entityopportunity-entity/
Adding a  Custom Group,Button to the existing tab of a specific entity (i.e for Opportunity Entity)	https://dynamicscrm2011.wordpress.com/2011/04/28/ribbon-customization-part-6-add-a-custom-group-and-custom-buttons-to-existing-tab-for-a-specific-entityopportunity-entity/
Hiding a Ribbon Button in CRM 2011	https://dynamicscrm2011.wordpress.com/2011/04/28/ribbon-customization-part-7-hiding-a-ribbon-button-in-dynamics-crm-2011/
Hiding a Group of Ribbon Buttons in CRM 2011	https://dynamicscrm2011.wordpress.com/2011/04/29/ribbon-customization-part-8-hiding-a-group-of-ribbon-buttons-in-dynamics-crm-2011/
Adding a Button to Existing Group for custom entity’s Ribbon in Dynamics CRM 2011	https://dynamicscrm2011.wordpress.com/2011/05/02/ribbon-customization-part-9-adding-a-button-to-existing-group-for-custom-entitys-ribbon-in-dynamics-crm-2011/

Ribbon Customization Part-9-Adding a Button to Existing Group for custom entity’s Ribbon in Dynamics CRM 2011

Today we will see how to add a button to the Entity Forms existing group for a custom entity

for the sake of doing this I created a custom entity with name “testcustomentity” and want to add a custom button under the “Save Group”

Follow the below steps to do the same

1. Create a solution
2. Create a new entity”testcustomentity” , Save
3. publish and export the solution
4. unzip the solution
5. Edit the customization.xml
6. Place the below code for the RibbonDiffXML

   1: <RibbonDiffXml>

   2:        <CustomActions>

   3:          

   4:        

   5:        <CustomAction Id="Sample.testcustomentity.form.Save.CustomAction"

   6:                  Location="Mscrm.Form.new_testcustomentity.MainTab.Save.Controls._children"

   7:                  Sequence="80">

   8:          <CommandUIDefinition>

   9:            <Button Id="Sample.testcustomentity.form.Save.Button"

  10:                    Command="Sample.testcustomentity.form.Save.Command"

  11:                    LabelText="$LocLabels:Sample.testcustomentity.form.Save.LabelText"

  12:                    ToolTipTitle="$LocLabels:Sample.testcustomentity.form.Save.LabelText"

  13:                    ToolTipDescription="$LocLabels:Sample.testcustomentity.form.Save.ToolTip"

  14:                    TemplateAlias="o1"

  15:                    Image16by16="/_imgs/ribbon/AddEmail_16.png"

  16:                    Image32by32="/_imgs/ribbon/Email_32.png" />

  17:          </CommandUIDefinition>

  18:        </CustomAction>

  19:        </CustomActions>

  20:        <Templates>

  21:          <RibbonTemplates Id="Mscrm.Templates"></RibbonTemplates>

  22:        </Templates>

  23:        <CommandDefinitions>

  24:          <CommandDefinition Id="Sample.testcustomentity.form.Save.Command">

  25:            <EnableRules/>

  26:            <DisplayRules/>

  27:  

  28:            <Actions>

  29:              <JavaScriptFunction Library="$webresource:new_/ShowMessage.js" FunctionName="show">

  30:                <StringParameter Value="2" />

  31:              </JavaScriptFunction>

  32:            </Actions>

  33:          </CommandDefinition>

  34:        </CommandDefinitions>

  35:          

  36:        <RuleDefinitions>

  37:          <TabDisplayRules />

  38:          <DisplayRules />

  39:          <EnableRules />

  40:        </RuleDefinitions>

  41:        <LocLabels>

  42:          <LocLabel Id="Sample.testcustomentity.form.Save.LabelText">

  43:            <Titles>

  44:              <Title languagecode="1033"

  45:                      description="Custom Button1" />

  46:            </Titles>

  47:          </LocLabel>

  48:          <LocLabel Id="Sample.testcustomentity.form.Save.ToolTip">

  49:            <Titles>

  50:              <Title languagecode="1033"

  51:                      description="Custom Button1" />

  52:            </Titles>

  53:          </LocLabel>

  54:        </LocLabels>

  55:      </RibbonDiffXml>

7. Save  the File
8. Zip the Solution and Import it
9. The result look like as shown in the below screenshot
10. 
11. The complete solution can be downloaded here
12. Happy learning.

Ribbon Customization Part-8-Hiding a Group of Ribbon Buttons in Dynamics CRM 2011

In my earlier post we have seen how to hide a ribbon button , In this post we will see how to hide the  group of buttons in the Ribbon

Now we will try to hide the “Actions”group in the Opportunity entity ribbon. see the below screenshot  which displays the Ribbon on the opportunity entity

We are going to hide the entire “Actions” group

Steps to Follow

1. We need to find the Id of the Ribbon component i.t “Actions”Group
2. We need to open the “opportunityribbon.xml” which will be available at   “sdk\samplecode\cs\client\ribbon\exportribbonxml” 
3. Open the “Opportuniyribbon.xml” find the “Actions”Group id as shown in the below screenshot
4. 
5. Now we need to create a new Solution
6. Add the Opportunity Entity
7. Save  and export the Solution
8. Unzip the Solution
9. Edit the “Customizations.xml”
10. Go to the <<RibbonDiffXML>>
11. Add the below  <<HideAction>> under the<<CustomActions>>under the <<RibbonDiffXML>>

   1: <!-- to hide the Actions Group on the HomepageGrid Ribbon -->

   2:          <HideCustomAction Location="Mscrm.HomepageGrid.opportunity.MainTab.Actions" 

   3:                            HideActionId="Mscrm.HomepageGrid.opportunity.MainTab.Actions.HideAction" />

   4:          <!-- to hide the Actions Group on the Entity Form Ribbon -->

   5:                                     

   6:          <HideCustomAction Location="Mscrm.Form.opportunity.MainTab.Actions" 

   7:                            HideActionId="Mscrm.Form.opportunity.MainTab.Actions.HideAction" />

12. Save  the File
13. ReZip
14. Import and Publish the Solution
15. Refresh the Browser and you can see the Opportunity Entity ribbon looks like the below screenshot
16. 
17. That’s it for now.. Happy learning
18. Download the Complete Solution from here

Ribbon Customization Part-7-Hiding a Ribbon Button in Dynamics CRM 2011

In this Post we will see  how to hide the CRM 2011 ribbon button , for this  I will take opportunity Entity and try to Hide the “Send Direct Email”Button which appear on the Home page grid of the Opportunity entity.

Steps to Follow

1. Create a New Solution  ,Add the Opportunity entity
2. Save and Export the solution
3. Unzip the solution and edit the “customizations.xml” using visual studio 2010
4. Here we need to find the Id of the “Send Direct Email” Button for that I would open the “Opportunityribbon.xml” available in “\\sdk\samplecode\cs\client\ribbon\exportribbonxml\exportedribbonxml” (this location depends on where you downloaded the Dynamics CRM 2011 SDK)
5. and I found the  Id of the button as “Mscrm.HomepageGrid.opportunity.SendDirectEmail”
6. Add the below code to  hide the button under the <<CustomActions>> under the <<RibbonDiffXML>>

   1: <HideCustomAction Location="Mscrm.HomepageGrid.opportunity.SendDirectEmail"

   2:                 HideActionId="Mscrm.HomepageGrid.opportunity.SendDirectEmail.HideAction" />   

7. Save
8. Rezip
9. Import and publish
10. Refresh the browser you can see the  the “Send Direct Email Button” won’t be displayed
11. Down load the complete solution from here

Ribbon Customization-Part 5-Add a Custom Tab, Custom Group and Custom Buttons to a Form Ribbon, Grid Ribbon for a Specific Entity(Opportunity Entity)

In my earlier post we have seen how to add custom buttons to the Entity Gird Ribbon for opportunity entity in CRM 2011

Now we will see how to add the same buttons to Entity Form level ribbon  and Sub Grid Ribbon ( The Ribbon that will show when the Control is in the Sub grid with in the Opportunity Entity Form and also  Sub grids showing the Opportunity Associated view)

1. Create a new Solution called ”OpportunityFormlevelRibbon”  then Add Opportunity entity, and any dependency objects  and also the web resource”ShowMessage.js” which we created in the earlier post and export it and save it in  the disk
2. unzip the solutions and Edit the customizations.xml
3. Add the below <<CustomActions>> in addition to the existing custom action

   1: <!--CustomAction  for  Tab, group, buttons to display in Form-->

   2:          <CustomAction Id="Sample.Form.opportunity.CustomTab.CustomAction" Location="Mscrm.Tabs._children" Sequence="40">

   3:            <CommandUIDefinition>

   4:              <Tab Id="Sample.Form.opportunity.CustomTab" Command="Sample.Form.opportunity.CustomTab" Title="$LocLabels:Sample.opportunity.CustomTab.Title" Description="$LocLabels:Sample.opportunity.CustomTab.Description" Sequence="40">

   5:                <Scaling Id="Sample.Form.opportunity.CustomTab.Scaling">

   6:                  <MaxSize Id="Sample.Form.opportunity.CustomTab.FirstGroup.MaxSize" GroupId="Sample.Form.opportunity.CustomTab.FirstGroup" Sequence="10" Size="LargeMedium" />

   7:                </Scaling>

   8:                <Groups Id="Sample.Form.opportunity.CustomTab.Groups">

   9:                  <Group Id="Sample.Form.opportunity.CustomTab.FirstGroup" Command="Sample.Form.opportunity.FirstGroup" Sequence="10" Title="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.Title" Template="Mscrm.Templates.3.3">

  10:                    <Controls Id="Sample.Form.opportunity.CustomTab.FirstGroup.Controls">

  11:                      <Button Id="Sample.Form.opportunity.CustomTab.FirstGroup.FirstButton" ToolTipTitle="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText" ToolTipDescription="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.ToolTipDescription" Command="Sample.Form.opportunity.FirstButton" Sequence="10" LabelText="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText" Alt="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText" Image16by16="/_imgs/ribbon/AddEmail_16.png" Image32by32="/_imgs/ribbon/Email_32.png" TemplateAlias="o1" />

  12:                      <Button Id="Sample.Form.opportunity.CustomTab.FirstGroup.SecondButton" ToolTipTitle="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText" ToolTipDescription="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.ToolTipDescription" Command="Sample.Form.opportunity.SecondButton" Sequence="20" LabelText="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText" Alt="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText" Image16by16="/_imgs/ribbon/AddEmail_16.png" Image32by32="/_imgs/ribbon/Email_32.png" TemplateAlias="o1" />

  13:                     

  14:                    </Controls>

  15:                  </Group>

  16:                </Groups>

  17:              </Tab>

  18:            </CommandUIDefinition>

  19:          </CustomAction>

  20:  

  21:          <!--CustomAction  for  Tab, group, buttons to display in  Form Subgrid-->

  22:          <CustomAction Id="Sample.SubGrid.opportunity.CustomTab.CustomAction" Location="Mscrm.SubGrid.opportunity.ContextualTabs._children" Sequence="40">

  23:            <CommandUIDefinition>

  24:              <Tab Id="Sample.SubGrid.opportunity.CustomTab" Command="Sample.SubGrid.opportunity.CustomTab" Title="$LocLabels:Sample.opportunity.CustomTab.Title" Description="$LocLabels:Sample.opportunity.CustomTab.Description" Sequence="500">

  25:                <Scaling Id="Sample.SubGrid.opportunity.CustomTab.Scaling">

  26:                  <MaxSize Id="Sample.SubGrid.opportunity.CustomTab.FirstGroup.MaxSize" GroupId="Sample.SubGrid.opportunity.CustomTab.FirstGroup" Sequence="10" Size="LargeMedium" />

  27:                </Scaling>

  28:                <Groups Id="Sample.SubGrid.opportunity.CustomTab.Groups">

  29:                  <Group Id="Sample.SubGrid.opportunity.CustomTab.FirstGroup" Command="Sample.SubGrid.opportunity.FirstGroup" Sequence="10" Title="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.Title" Template="Mscrm.Templates.3.3">

  30:                    <Controls Id="Sample.SubGrid.opportunity.CustomTab.FirstGroup.Controls">

  31:                       <Button Id="Sample.SubGrid.opportunity.CustomTab.FirstGroup.FirstButton" ToolTipTitle="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText" ToolTipDescription="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.ToolTipDescription" Command="Sample.SubGrid.opportunity.FirstButton" Sequence="10" LabelText="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText" Alt="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText" Image16by16="/_imgs/ribbon/AddEmail_16.png" Image32by32="/_imgs/ribbon/Email_32.png" TemplateAlias="o1" />

  32:                      <Button Id="Sample.SubGrid.opportunity.CustomTab.FirstGroup.SecondButton" ToolTipTitle="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText" ToolTipDescription="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.ToolTipDescription" Command="Sample.SubGrid.opportunity.SecondButton" Sequence="20" LabelText="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText" Alt="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText" Image16by16="/_imgs/ribbon/AddEmail_16.png" Image32by32="/_imgs/ribbon/Email_32.png" TemplateAlias="o1" />                      

  33:                    </Controls>

  34:                  </Group>

  35:                </Groups>

  36:              </Tab>

  37:            </CommandUIDefinition>

  38:          </CustomAction>

4. Add the below CommandDefinitions  for the above buttons, tab,group

   1: <!--Command Definetions for  Tab, Group, Buttons under Form needs to be included here-->

   2:  

   3:    <CommandDefinition Id="Sample.Form.opportunity.FirstButton">

   4:      <EnableRules />

   5:      <DisplayRules />

   6:      <Actions>

   7:        <Url Address="http://www.microsoft.com"></Url>

   8:      </Actions>

   9:    </CommandDefinition>

  10:    <CommandDefinition Id="Sample.Form.opportunity.SecondButton">

  11:      <EnableRules />

  12:      <DisplayRules />

  13:      <Actions>

  14:        <JavaScriptFunction Library="$webresource:new_/ShowMessage.js" FunctionName="show">

  15:          <StringParameter Value="2" />

  16:        </JavaScriptFunction>

  17:      </Actions>

  18:    </CommandDefinition>

  19:    <CommandDefinition Id="Sample.Form.opportunity.FirstGroup">

  20:      <EnableRules>

  21:        <EnableRule Id="Mscrm.Enabled " />

  22:      </EnableRules>

  23:      <DisplayRules>

  24:        <DisplayRule Id="Mscrm.CanWriteOpportunity" />

  25:      </DisplayRules>

  26:      <Actions />

  27:    </CommandDefinition>

  28:    <CommandDefinition Id="Sample.Form.opportunity.CustomTab">

  29:      <EnableRules>

  30:        <EnableRule Id="Mscrm.Enabled " />

  31:      </EnableRules>

  32:      <DisplayRules>

  33:        <DisplayRule Id="Mscrm.CanWriteOpportunity" />

  34:      </DisplayRules>

  35:      <Actions />

  36:    </CommandDefinition>

  37:  

  38:    <!--Command Definetions for  Tab, Group, Buttons under Form's SubGrid needs to be included here-->

  39:    <CommandDefinition Id="Sample.SubGrid.opportunity.FirstButton">

  40:      <EnableRules />

  41:      <DisplayRules />

  42:      <Actions>

  43:        <Url Address="http://www.microsoft.com"></Url>

  44:      </Actions>

  45:    </CommandDefinition>

  46:    <CommandDefinition Id="Sample.SubGrid.opportunity.SecondButton">

  47:      <EnableRules />

  48:      <DisplayRules />

  49:      <Actions>

  50:        <JavaScriptFunction Library="$webresource:new_/ShowMessage.js" FunctionName="show">

  51:          <StringParameter Value="2" />

  52:        </JavaScriptFunction>

  53:      </Actions>

  54:    </CommandDefinition>

  55:    <CommandDefinition Id="Sample.SubGrid.opportunity.FirstGroup">

  56:      <EnableRules>

  57:        <EnableRule Id="Mscrm.Enabled " />

  58:      </EnableRules>

  59:      <DisplayRules>

  60:        <DisplayRule Id="Mscrm.CanWriteOpportunity" />

  61:      </DisplayRules>

  62:      <Actions />

  63:    </CommandDefinition>

  64:    <CommandDefinition Id="Sample.SubGrid.opportunity.CustomTab">

  65:      <EnableRules>

  66:        <EnableRule Id="Mscrm.Enabled " />

  67:      </EnableRules>

  68:      <DisplayRules>

  69:        <DisplayRule Id="Mscrm.CanWriteOpportunity" />

  70:      </DisplayRules>

  71:      <Actions />

  72:    </CommandDefinition>

  73:    

5. Add the below Tabrules to display the tab in the Form context, Subgrid context, Subgrid context when showing in the associated view as well

   1: <TabDisplayRule TabCommand="Sample.SubGrid.opportunity.CustomTab">

   2:             <EntityRule EntityName="opportunity" Context="SubGridStandard" />

   3:             <EntityRule EntityName="opportunity" Context="SubGridAssociated" />

   4:           </TabDisplayRule>

   5:           <TabDisplayRule TabCommand="Sample.Form.opportunity.CustomTab">

   6:             <EntityRule EntityName="opportunity" Context="Form" AppliesTo="PrimaryEntity" />

   7:           </TabDisplayRule>

6. Now you can zip  and install the solution and you can the buttons appearing in the following places
1. Entity Grid
2. Entity Form
3. Entity SubGrid
4. on Opportunity Associated view as well
7. You can Download the complete Solution from here.

Ribbon Customization-Part 4-Add a Custom Tab, Custom Group and Custom Buttons to a Grid Ribbon for a Specific Entity(Opportunity Entity)

In my earlier post we have seen how to add a custom tab to a specific entity

Today I am going to perform the following tasks

1. Adding  a Custom Group to the  CRM 2011 Ribbon for a specific entity( I am taking opportunity entity for this purpose)
2. Adding  a Custom Buttons to the Custom Group With the Specific Actions for the Buttons
   1. On Click of First Button we will open the “www.microsoft.com”
   2. On Click of the Second Button we will  call a simple Java script function Which exists in a web resource.

Coming to the Actions in sequence,

• Create a new Solution called “OpportunitySolution” and add Opportunity entity  and a newly created web resource called ”ShowMessage.js” with the following Code

   1: function show(Val)

   2: {

   3: alert("Button "+Val+" action performed.");

   4: }

• Publish the customizations
• Export the Solutions and Save
• Unzip the Solution and Edit the customizations.xml  with  any XML Editor  I prefer VS 2010.
• search for <Entity> as shown the below screenshot Collapse the <FormXML> tag then you can see the <RibbonDiffXML> for the opportunity
• 
• Add the CustomActions to the RibbonDiffXMLwith the below code

   1: <CustomActions>

   2:        <CustomAction Id="Sample.Grid.opportunity.CustomTab.CustomAction" Location="Mscrm.Tabs._children" Sequence="40">

   3:          <CommandUIDefinition>

   4:            <Tab Id="Sample.Grid.opportunity.CustomTab" Command="Sample.Grid.opportunity.CustomTab" Title="$LocLabels:Sample.opportunity.CustomTab.Title" Description="$LocLabels:Sample.opportunity.CustomTab.Description" Sequence="500">

   5:              <Scaling Id="Sample.Grid.opportunity.CustomTab.Scaling">

   6:                <MaxSize Id="Sample.Grid.opportunity.CustomTab.FirstGroup.MaxSize" GroupId="Sample.Grid.opportunity.CustomTab.FirstGroup" Sequence="10" Size="LargeMedium" />

   7:              </Scaling>

   8:              <Groups Id="Sample.Grid.opportunity.CustomTab.Groups">

   9:                <Group Id="Sample.Grid.opportunity.CustomTab.FirstGroup" Command="Sample.Grid.opportunity.FirstGroup" Sequence="10" Title="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.Title" Template="Mscrm.Templates.3.3">

  10:                  <Controls Id="Sample.Grid.opportunity.CustomTab.FirstGroup.Controls">

  11:                    <Button Id="Sample.Grid.opportunity.CustomTab.FirstGroup.FirstButton" ToolTipTitle="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText"

  12:                            ToolTipDescription="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.ToolTipDescription"

  13:                            Command="Sample.Grid.opportunity.FirstButton"

  14:                            Sequence="10"

  15:                            LabelText="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText"

  16:                            Alt="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText"

  17:                            Image16by16="/_imgs/ribbon/AddEmail_16.png"

  18:                            Image32by32="/_imgs/ribbon/Email_32.png" TemplateAlias="o1" />

  19:                    <Button Id="Sample.Grid.opportunity.CustomTab.FirstGroup.SecondButton"

  20:                            ToolTipTitle="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText"

  21:                            ToolTipDescription="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.ToolTipDescription"

  22:                            Command="Sample.Grid.opportunity.SecondButton"

  23:                            Sequence="20"

  24:                            LabelText="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText"

  25:                            Alt="$LocLabels:Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText"

  26:                            Image16by16="/_imgs/ribbon/AddEmail_16.png"

  27:                            Image32by32="/_imgs/ribbon/Email_32.png" TemplateAlias="o1" />

  28:  

  29:                  </Controls>

  30:                </Group>

  31:              </Groups>

  32:            </Tab>

  33:          </CommandUIDefinition>

  34:        </CustomAction>

  35:      </CustomActions>

• Add the Templates with the following code

   1: <Templates>

   2:          <RibbonTemplates Id="Mscrm.Templates"></RibbonTemplates>

   3:        </Templates>

• Add the <<CommandDefinitions>> with the below code

   1: <CommandDefinitions>

   2:          <CommandDefinition Id="Sample.Grid.opportunity.CustomTab">

   3:            <EnableRules>

   4:              <EnableRule Id="Mscrm.Enabled " />

   5:            </EnableRules>

   6:            <DisplayRules>

   7:              <DisplayRule Id="Mscrm.CanWriteOpportunity" />

   8:            </DisplayRules>

   9:            <Actions />

  10:          </CommandDefinition>

  11:          <CommandDefinition Id="Sample.Grid.opportunity.FirstGroup">

  12:            <EnableRules>

  13:              <EnableRule Id="Mscrm.Enabled " />

  14:            </EnableRules>

  15:            <DisplayRules>

  16:              <DisplayRule Id="Mscrm.CanWriteOpportunity" />

  17:            </DisplayRules>

  18:            <Actions />

  19:          </CommandDefinition>

  20:          <CommandDefinition Id="Sample.Grid.opportunity.FirstButton">

  21:            <EnableRules/>

  22:            <DisplayRules/>

  23:            <Actions>

  24:              <Url Address ="http://www.microsoft.com"></Url>

  25:            </Actions>

  26:          </CommandDefinition>

  27:          <CommandDefinition Id="Sample.Grid.opportunity.SecondButton">

  28:            <EnableRules/>

  29:            <DisplayRules/>

  30:            <Actions>

  31:              <JavaScriptFunction Library="$webresource:new_/ShowMessage.js" FunctionName="show">

  32:                <StringParameter Value="2" />

  33:              </JavaScriptFunction>

  34:            </Actions>

  35:          </CommandDefinition >

• Observe how I have added the Actions for the buttons ,generally actions are performed by ribbon controls and these are of 2 types
• Java script functions
• Opening an UL
• If you observe the First button action is “Opening an URL”
• For  the Second Button action is –On click of the Button it would show the Message from the Java Script Function and also passing a string parameter from the Ribbon control to the JavaScript function
• Add the <<RuleDefinitions>> with the Following code

   1: <RuleDefinitions>

   2:         <TabDisplayRules>

   3:           <TabDisplayRule TabCommand="Sample.Grid.opportunity.CustomTab">

   4:             <EntityRule EntityName="opportunity" Context="HomePageGrid" />

   5:           </TabDisplayRule>

   6:         </TabDisplayRules>

   7:         <DisplayRules/>

   8:         <EnableRules />

   9:       </RuleDefinitions>

• In the Rule Definition I specified  exclusively that the buttons should appear on the Grid Ribbon only. Not on the Form Ribbon and Sub Grid Ribbon
• Add the <LocLables> with the below code

   1: <LocLabels>

   2:        <LocLabel Id="Sample.opportunity.CustomTab.FirstGroup.FirstButton.LabelText">

   3:          <Titles>

   4:            <Title languagecode="1033" description="First Button" />

   5:          </Titles>

   6:        </LocLabel>

   7:        <LocLabel Id="Sample.opportunity.CustomTab.Description">

   8:          <Titles>

   9:            <Title languagecode="1033" description="A custom tab for the Opportunity entity." />

  10:          </Titles>

  11:        </LocLabel>

  12:        <LocLabel Id="Sample.opportunity.CustomTab.FirstGroup.Title">

  13:          <Titles>

  14:            <Title languagecode="1033" description="First Group" />

  15:          </Titles>

  16:        </LocLabel>

  17:        <LocLabel Id="Sample.opportunity.CustomTab.FirstGroup.FirstButton.ToolTipDescription">

  18:          <Titles>

  19:            <Title languagecode="1033" description="The first button in the first group." />

  20:          </Titles>

  21:        </LocLabel>

  22:        <LocLabel Id="Sample.opportunity.CustomTab.Title">

  23:          <Titles>

  24:            <Title languagecode="1033" description="Custom Tab" />

  25:          </Titles>

  26:        </LocLabel>

  27:        <LocLabel Id="Sample.opportunity.CustomTab.FirstGroup.SecondButton.LabelText">

  28:          <Titles>

  29:            <Title languagecode="1033" description="Second Button" />

  30:          </Titles>

  31:        </LocLabel>

  32:        <LocLabel Id="Sample.opportunity.CustomTab.FirstGroup.SecondButton.ToolTipDescription">

  33:          <Titles>

  34:            <Title languagecode="1033" description="The second button in the first group." />

  35:          </Titles>

  36:        </LocLabel>

  37:      </LocLabels>

• Check the below screenshots  for the functionality
• Initial display of the buttons on the Opportunity Entity Grid ribbon
• 
• On Click of the  first button an window will open with the URL www.microsoft.com as shown the below screenshot
• 
• On Click of the second Button  the result look like below screenshot and the “2” is the string parameter we passed to the JavaScript function
• 
• You can download the Complete Solution from here

Happy Learning

Ribbon Customization-Part 3-Add a Custom Tab to a Specific Entity(Opportunity Entity)

In this post we will see how to add a custom tab to specific entity. I am choosing to add a Custom Tab with name “myCustomTab” to the “Opportunity” Entity

1. Create a new solution and add the opportunity entity  save and export the solution
2. Unzip the solution and open the customization file in visual studio
3. Make sure that you enable the Intellisense  for visual studio 2010 to edit the xml files as discussed in my earlier post
4. AS the customization file consists of the entire entity we need to find out where the RibbonDiffXML. you can see <RibbonDiffXml> by minimizing the <FormXml> as shown in the below screenshot

 

5.       To understand  the structure of the Ribbon available for Opportunity entity SDK has given  all entity ribbon xmls  and you can find out at sdk\samplecode\cs\client\ribbon\exportribbonxml\exportedribbonxml\    and you can select the “opportunityribbon.xml” in the Visual studio.

6.        Understand how the existing tabs has been created in the “opportunityribbon.xml” and refer my earlier posts for better understanding on Ribbon customization.

1.  
   1. MS Dynamics CRM 2011 :Ribbon Customization Part-1-Add a custom tab to Microsoft Dynamics CRM 2011 ribbon
   2. MS Dynamics CRM 2011 :Ribbon Customization Part-2-Understanding the Ribbon customization

7.        The <RibbonDiffXml> in the Opportunity entity appears as below

   <RibbonDiffXml>

        <CustomActions>

          <CustomAction Id =”Mscrm.Isv.GlobalCustomAction” Location=”Mscrm.Tabs._children” Sequence=”500″ Title=”myCustomAction” >

            <CommandUIDefinition>

              <Tab Id=”Mscrm.HomepageGrid.opportunity.CustomTab” Command=”Mscrm.HomepageGrid.opportunity.CustomTab” Title=”myCustomTab” Description=”myCustomTab” Sequence=”300″>

                <Scaling Id=”Mscrm.HomepageGrid.opportunity.CustomTab.Scaling”>

                  <MaxSize Id=”Mscrm.HomepageGrid.opportunity.CustomTab.CustomGroup.MaxSize” GroupId=”Mscrm.HomepageGrid.opportunity.CustomTab.CustomGroup” Sequence=”20″ Size=”LargeMedium” />

                  <Scale Id=”Mscrm.HomepageGrid.opportunity.CustomTab.CustomGroup.Scale.1″ GroupId=”Mscrm.HomepageGrid.opportunity.CustomTab.CustomGroup” Sequence=”120″ Size=”LargeSmall” />

                  </Scaling>

                <Groups Id=”Mscrm.HomepageGrid.opportunity.CustomTab.Groups”>

                </Groups>

              </Tab>            

            </CommandUIDefinition>                     

          </CustomAction>         

        </CustomActions>

         <Templates>

          <RibbonTemplates Id=”Mscrm.Templates”></RibbonTemplates>

        </Templates>

        <CommandDefinitions/>        

        <RuleDefinitions>

          <TabDisplayRules>

            <TabDisplayRule TabCommand =”Mscrm.HomepageGrid.opportunity.CustomTab” >

              <EntityRule AppliesTo =”SelectedEntity”  EntityName =”opportunity” Context =”HomePageGrid”/>

            </TabDisplayRule>

          </TabDisplayRules>          

          <DisplayRules/>         

          <EnableRules />

        </RuleDefinitions>

        <LocLabels/>       

      </RibbonDiffXml>

      8.        The end Result is as shown in the below screenshot 

     

9.        Download the unmanaged solution from here

MS Dynamics CRM 2011 :Ribbon Customization Part-2-Understanding the Ribbon customization

Revisit my earlier post and dig in to the details of how we added a tab and also button to the tab.

1.       As we need to Add a “Tab” , as we understood from the Post 1, any modifications to the ribbon definitions should be done at  <Custom Actions>
2. See the picture below,<Custom Action> can contain <Custom Action> or <Hide Action>
   

   RibbonDiffXML

    

3. <Custom Action> should have Id, Location ,Sequence, Title, CommandUIDefinition

So we added the following Custom Action

<CustomAction Id=“Mscrm.Isv.GlobalCustomAction“ Location=“Mscrm.Tabs._children“ Sequence=“100“>

 

 

 

 

4.  < CommandUIDefinition > can contain any  type (for ex: button,tab etc.,) what is displayed in the  above Screenshot. But we are interested to add Tab,So refer the screenshot for the Properties and the elements Tabtaype contains so we added the following < CommandUIDefinition >

< CommandUIDefinition >       

<Tab Id=”Mscrm.Isv.Global” Command=”Mscrm.Isv.Global” Description=”Custom Tab” Title=”Custom Tab” Sequence=”1000″>

            <Scaling Id=”Mscrm.Isv.Global.Scaling”>

              <MaxSize Id=”Mscrm.Isv.Global.Group0.MaxSize” Sequence=”10″ GroupId=”Mscrm.Isv.Global.Group0″ Size=”Large” />

              <Scale Id=”Mscrm.Isv.Global.Group0.Scale.Medium” Sequence=”20″ GroupId=”Mscrm.Isv.Global.Group0″ Size=”Medium” />

              <Scale Id=”Mscrm.Isv.Global.Group0.Scale.Small” Sequence=”30″ GroupId=”Mscrm.Isv.Global.Group0″ Size=”Small” />

              <Scale Id=”Mscrm.Isv.Global.Group0.Scale.Popup” Sequence=”40″ GroupId=”Mscrm.Isv.Global.Group0″ Size=”Popup” />

            </Scaling>

            <Groups Id=”Mscrm.Isv.Global.Groups”>

              <Group Id=”Mscrm.Isv.Global.Group0″ Sequence=”10″ Command=”Mscrm.Isv.Global.Group0″ Title=”Custom Group1″ Description=”Custom Group1″ Template=”Mscrm.Templates.Flexible”>

                <Controls Id=”Mscrm.Isv.Global.Group0.Controls”>

                  <Button Id=”Mscrm.Isv.Global.Group0.Control0″ Command=”Mscrm.Isv.Global.Group0.Control0″ LabelText=”$LocLabels:Mscrm.Isv.Global.Group0.Control0.LocLabel” ToolTipTitle=”$LocLabels:Mscrm.Isv.Global.Group0.Control0.LocLabel” ToolTipDescription=”$LocLabels:Mscrm.Isv.Global.Group0.Control0.ToolTip.LocLabel” Image16by16=”/_imgs/area/18_home.gif” Image32by32=”/_imgs/area/18_home.gif” Image16by16Class=”ms-crm-Upgraded-Ribbon-Image16″ Image32by32Class=”ms-crm-Upgraded-Ribbon-Image32″ Sequence=”10″ TemplateAlias=”o1″ />

                </Controls>

              </Group>

            </Groups>

          </Tab>

        </CommandUIDefinition>

5.   After this we need to specify the <CommandDefinitions> which Specifies a set of rules that control how a ribbon element is displayed and actions to perform that can be referenced by ribbon elements and controls See the below screenshot for how the Command definition should be done

CommandDefinetion Dynamics CRM 2011 ribbon

<CommandDefinitions>

      <CommandDefinition Id=”Mscrm.Isv.Global.Group0.Control0″>

        <EnableRules />

        <DisplayRules>

          <DisplayRule Id=”Mscrm.Isv.Global.Group0.Control0″ />

        </DisplayRules>

        <Actions>         

        </Actions>

      </CommandDefinition>

      <CommandDefinition Id=”Mscrm.Isv.Global”>

        <EnableRules />

        <DisplayRules>

          <DisplayRule Id=”Mscrm.Isv.Global” />

        </DisplayRules>

        <Actions />

      </CommandDefinition>

      <CommandDefinition Id=”Mscrm.Isv.Global.Group0″>

        <EnableRules />

        <DisplayRules />

        <Actions />

      </CommandDefinition>

    </CommandDefinitions>

6.  Then we need to add the  Rule definetions. Please check the below screenshot for the details how the Rule definitions should be configured so we added

<RuleDefinitions>

      <TabDisplayRules>

        <TabDisplayRule TabCommand=”Mscrm.Isv.Global”>

          <PageRule Address=”*” />

        </TabDisplayRule>

      </TabDisplayRules>

      <DisplayRules>

        <DisplayRule Id=”Mscrm.Isv.Global”>

           <OrRule>

            <Or>

              <CrmClientTypeRule Type=”Web” />

            </Or>

           </OrRule>

        </DisplayRule>

        <DisplayRule Id=”Mscrm.Isv.Global.Group0.Control0″>

          <CrmOfflineAccessStateRule State=”Offline” InvertResult=”true” />

        </DisplayRule>

      </DisplayRules>

      <EnableRules />

    </RuleDefinitions>

7.  At the End we have added thee Lockables where you can specify the text to display in the ribbon labels and tooltips

<LocLabel Id=”Mscrm.Isv.Global.Group0.Control0.LocLabel”>

        <Titles>

          <Title languagecode=”1033″ description=”Custom Button” />

        </Titles>

      </LocLabel>

      <LocLabel Id=”Mscrm.Isv.Global.Group0.Control0.ToolTip.LocLabel”>

        <Titles>

          <Title languagecode=”1033″ description=”Custom Button” />

        </Titles>

      </LocLabel>

    </LocLabels>