Sample Code to add a custom tab to a custom entity in CRM 2011

Hi,

Customizing the Ribbon interface in CRM 2011 is not that easy, if we compare it to the ISV.CONFIG.

Here i am posting a sample xml file that we can use to create a custom tab within an entity.

Suppose the schema name of the entity is new_test, so use the following code to add a custom tab to it.

I am posting the RibbonDiffXml part

<RibbonDiffXml>
 <CustomActions>
  <CustomAction Id=”Sample.Form.new_test.CustomTab.CustomAction” Location=”Mscrm.Tabs._children” Sequence=”40″>
   <CommandUIDefinition>
    <Tab Id=”Sample.Form.new_test.CustomTab” Command=”Sample.Form.new_test.CustomTab” Title=”My First Custom Tab” Description=”Finally managed to put my first custom tab” Sequence=”40″>
     <Scaling Id=”Sample.Form.new_test.CustomTab.Scaling”>
      <MaxSize Id=”Sample.Form.new_test.CustomTab.FirstGroup.MaxSize” GroupId=”Sample.Form.new_test.CustomTab.FirstGroup” Sequence=”10″ Size=”LargeMedium”/>
     </Scaling>
     <Groups Id=”Sample.Form.new_test.CustomTab.Groups”>
      <Group Id=”Sample.Form.new_test.CustomTab.FirstGroup” Command=”Sample.Form.new_test.FirstGroup” Sequence=”10″ Title=”Custom Group” Template=”Mscrm.Templates.3.3″>
       <Controls Id=”Sample.Grid.new_test.CustomTab.FirstGroup.Controls”/>
      </Group>
     </Groups>
    </Tab>
   </CommandUIDefinition>
  </CustomAction>
 </CustomActions>
 <Templates>
  <RibbonTemplates Id=”Mscrm.Templates”/>
 </Templates>
 <CommandDefinitions>
  <CommandDefinition Id=”Sample.Form.new_test.CustomTab”>
   <EnableRules>
    <EnableRule Id=”Mscrm.Enabled “/>
   </EnableRules>
   <DisplayRules>     
    </DisplayRules>
   <Actions/>
  </CommandDefinition>
  <CommandDefinition Id=”Sample.Form.new_test.FirstGroup”>
   <EnableRules>
    <EnableRule Id=”Mscrm.Enabled “/>
   </EnableRules>
   <DisplayRules>
    </DisplayRules>
   <Actions/>
  </CommandDefinition>
 </CommandDefinitions>
 <RuleDefinitions>
  <TabDisplayRules>
   <TabDisplayRule TabCommand=”Sample.Form.new_test.CustomTab”>
    <EntityRule EntityName=”new_test” Context=”Form” AppliesTo=”PrimaryEntity”/>
   </TabDisplayRule>
  </TabDisplayRules>
  <DisplayRules/>
  <EnableRules/>
 </RuleDefinitions>
 <LocLabels/>
</RibbonDiffXml>

Hope it helps !


3 thoughts on “Sample Code to add a custom tab to a custom entity in CRM 2011

  1. Hi Nishant,

    Thanks for providing a sample of the ribbon customisation. I tried to follow something similar in creating a button in the ribbon for a specific entity.
    When I import the solution it gives me an error for the entity ribbon. Exporting the import result to excel it says “object reference not set to an instance of an object” which is a very generic error. Can you suggest anything that may have caused this exception.

    David

Share your thoughts

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s