Tutorial 9

Task

• When a lead qualified, send an email (with an email template) notification to all team members of the current user belong to teams

Prerequisites

• Finish Tutorial 1: Plugin
• Finish Tutorial 2: Unit Test Plugin
• Finish Tutorial 3: WebResource
• Finish Tutorial 4: Unit Test WebResource
• Finish Tutorial 5: Custom Workflow
• Finish Tutorial 6: WebApiClient
• Finish Tutorial 7: Custom Action
• Finish Tutorial 8: Plugin and Unit Test Plugin

Explain

This tutorial is the combine of these tutorials: 5, 6, 7, 8 that make the final solution the customer want

1. User create a new lead then send an email to all team members
2. If user has security role "Qualify Lead", they can see the button "QUALIFY"
3. User click button "QUALIFY", it create Account and Contact then redirect to Account created
4. Process "QUALIFY" should copy field Field1, Field2, Field3 from lead to account
5. When lead qualified then send an email to all team members

Coding

Ribbon Workbench

1. Hide 4 button in the Homepage of Lead entity
   • Mscrm.HomepageGrid.lead.ConvertLeadAs
   • Mscrm.HomepageGrid.lead.ConvertLeadAs.Web
   • Mscrm.HomepageGrid.lead.ConvertLeadQuick
   • Mscrm.HomepageGrid.lead.ConvertLeadQuick.Web
2. Hide 4 button in the Form of Lead entity
   • Mscrm.Form.lead.ConvertLeadAs
   • Mscrm.Form.lead.ConvertLeadAs.Web
   • Mscrm.Form.lead.ConvertLeadQuick
   • Mscrm.Form.lead.ConvertLeadQuick.Web
3. Copy button
   • Mscrm.Form.lead.ConvertLeadAs and paste as name paz.Mscrm.Form.lead.ConvertLeadQuick
   • Mscrm.Form.lead.ConvertLeadQuick.Web and paste as name paz.Mscrm.Form.lead.ConvertLeadQuick.Web
4. Edit Customise Command of 2 button paz.Mscrm.Form.lead.ConvertLeadQuick, paz.Mscrm.Form.lead.ConvertLeadQuick.Web
5. Add enable rule
   • Id: paz.lead.EnableRule.HasRole
   • CustomRule
     • Default: True
     • FunctionName: isNaN
     • Library: $webresource:paz_/lib/WebApiClient.js
   • CustomRule
     • FunctionName: formLead.HasRole
     • Library: $webresource:paz_/entities/Lead.js
     • String Parameter: Qualify Lead
6. Add enable rule paz.lead.EnableRule.HasRole to 2 command Mscrm.Form.lead.ConvertQuick and Mscrm.Form.lead.ConvertQuick.Web
7. Edit Actions in 2 command Mscrm.Form.lead.ConvertQuick and Mscrm.Form.lead.ConvertQuick.Web
   • Library: $webresource:paz_/entities/Lead.js
   • Function Name: formLead.QualifyLead_Click
   • _CRM Parameter__: PrimaryControl
8. Publish
9. The RibbonDiffXml bellow

<?xml version="1.0" encoding="utf-16"?>
<RibbonDiffXml xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomActions>
    <CustomAction Id="paz.Mscrm.Form.lead.ConvertLeadQuick.CustomAction" Location="Mscrm.Form.lead.MainTab.Actions.Controls._children" Sequence="0">
      <CommandUIDefinition>
        <Button Alt="$LocLabels:Ribbon.Form.opportunity.MainTab.Actions.Convert" Command="Mscrm.Form.lead.ConvertQuick" Id="paz.Mscrm.Form.lead.ConvertLeadQuick" Image32by32="$webresource:MarketingSales/_imgs/ribbon/ConvertLead_32.png" Image16by16="$webresource:MarketingSales/_imgs/ribbon/ConvertLead_16.png" LabelText="$LocLabels:Ribbon.Form.opportunity.MainTab.Actions.Convert" Sequence="0" TemplateAlias="o1" ToolTipTitle="$LocLabels:Ribbon.Form.Lead.MainTab.Actions.Convert.ToolTipTitle" ToolTipDescription="$LocLabels:Ribbon.Tooltip.ConvertLead" ModernImage="Qualify" />
      </CommandUIDefinition>
    </CustomAction>
    <CustomAction Id="paz.Mscrm.Form.lead.ConvertLeadQuick.Web.CustomAction" Location="Mscrm.Form.lead.MainTab.Actions.Controls._children" Sequence="0">
      <CommandUIDefinition>
        <Button Alt="$LocLabels:Ribbon.Form.opportunity.MainTab.Actions.Convert" Command="Mscrm.Form.lead.ConvertQuick.Web" Id="paz.Mscrm.Form.lead.ConvertLeadQuick.Web" Image32by32="$webresource:MarketingSales/_imgs/ribbon/ConvertLead_32.png" Image16by16="$webresource:MarketingSales/_imgs/ribbon/ConvertLead_16.png" LabelText="$LocLabels:Ribbon.Form.opportunity.MainTab.Actions.Convert" Sequence="0" TemplateAlias="o1" ToolTipTitle="$LocLabels:Ribbon.Form.Lead.MainTab.Actions.Convert.ToolTipTitle" ToolTipDescription="$LocLabels:Ribbon.Tooltip.ConvertLead" ModernImage="Qualify" />
      </CommandUIDefinition>
    </CustomAction>
    <HideCustomAction HideActionId="paz.Mscrm.HomepageGrid.lead.ConvertLeadAs.Hide" Location="Mscrm.HomepageGrid.lead.ConvertLeadAs" />
    <HideCustomAction HideActionId="paz.Mscrm.HomepageGrid.lead.ConvertLeadAs.Web.Hide" Location="Mscrm.HomepageGrid.lead.ConvertLeadAs.Web" />
    <HideCustomAction HideActionId="paz.Mscrm.HomepageGrid.lead.ConvertLeadQuick.Hide" Location="Mscrm.HomepageGrid.lead.ConvertLeadQuick" />
    <HideCustomAction HideActionId="paz.Mscrm.HomepageGrid.lead.ConvertLeadQuick.Web.Hide" Location="Mscrm.HomepageGrid.lead.ConvertLeadQuick.Web" />
    <HideCustomAction HideActionId="paz.Mscrm.Form.lead.ConvertLeadQuick.Hide" Location="Mscrm.Form.lead.ConvertLeadQuick" />
    <HideCustomAction HideActionId="paz.Mscrm.Form.lead.ConvertLeadQuick.Web.Hide" Location="Mscrm.Form.lead.ConvertLeadQuick.Web" />
    <HideCustomAction HideActionId="paz.Mscrm.Form.lead.ConvertLeadAs.Hide" Location="Mscrm.Form.lead.ConvertLeadAs" />
    <HideCustomAction HideActionId="paz.Mscrm.Form.lead.ConvertLeadAs.Web.Hide" Location="Mscrm.Form.lead.ConvertLeadAs.Web" />
  </CustomActions>
  <Templates>
    <RibbonTemplates Id="Mscrm.Templates" />
  </Templates>
  <CommandDefinitions>
    <CommandDefinition Id="Mscrm.Form.lead.ConvertQuick">
      <EnableRules>
        <EnableRule Id="Mscrm.LeadIsOpen" />
        <EnableRule Id="Mscrm.Form.lead.IsUCI" />
        <EnableRule Id="Mscrm.IsEntityAvailableForUserInMocaOffline" />
        <EnableRule Id="Mscrm.IsAccountAvailableInMocaOffline" />
        <EnableRule Id="Mscrm.IsContactAvailableInMocaOffline" />
        <EnableRule Id="Mscrm.IsOpportunityAvailableInMocaOffline" />
        <EnableRule Id="paz.lead.EnableRule.HasRole" />
      </EnableRules>
      <DisplayRules>
        <DisplayRule Id="Mscrm.DynamicMenu.NewRecord.opportunity" />
        <DisplayRule Id="Mscrm.HideOnOutlookClient" />
      </DisplayRules>
      <Actions>
        <JavaScriptFunction FunctionName="formLead.QualifyLead_Click" Library="$webresource:paz_/entities/Lead.js">
          <CrmParameter Value="PrimaryControl" />
        </JavaScriptFunction>
      </Actions>
    </CommandDefinition>
    <CommandDefinition Id="Mscrm.Form.lead.ConvertQuick.Web">
      <EnableRules>
        <EnableRule Id="Mscrm.LeadIsOpen" />
        <EnableRule Id="Mscrm.Form.lead.IsNotUCI" />
        <EnableRule Id="Mscrm.IsEntityAvailableForUserInMocaOffline" />
        <EnableRule Id="Mscrm.IsAccountAvailableInMocaOffline" />
        <EnableRule Id="Mscrm.IsContactAvailableInMocaOffline" />
        <EnableRule Id="Mscrm.IsOpportunityAvailableInMocaOffline" />
      </EnableRules>
      <DisplayRules>
        <DisplayRule Id="Mscrm.SingleQualifyStatusCode" />
        <DisplayRule Id="Mscrm.DynamicMenu.NewRecord.opportunity" />
      </DisplayRules>
      <Actions>
        <JavaScriptFunction FunctionName="formLead.QualifyLead_Click" Library="$webresource:paz_/entities/Lead.js">
          <CrmParameter Value="PrimaryControl" />
        </JavaScriptFunction>
      </Actions>
    </CommandDefinition>
  </CommandDefinitions>
  <RuleDefinitions>
    <TabDisplayRules />
    <DisplayRules>
      <DisplayRule Id="Mscrm.DynamicMenu.NewRecord.opportunity">
        <EntityPrivilegeRule PrivilegeType="Create" PrivilegeDepth="Basic" EntityName="opportunity" />
        <EntityPrivilegeRule PrivilegeType="Append" PrivilegeDepth="Basic" EntityName="opportunity" />
        <OrRule>
          <Or>
            <EntityPrivilegeRule PrivilegeType="AppendTo" PrivilegeDepth="Basic" EntityName="account" />
          </Or>
          <Or>
            <EntityPrivilegeRule PrivilegeType="AppendTo" PrivilegeDepth="Basic" EntityName="contact" />
          </Or>
        </OrRule>
      </DisplayRule>
      <DisplayRule Id="Mscrm.HideOnOutlookClient">
        <CrmClientTypeRule Type="Outlook" InvertResult="true" />
      </DisplayRule>
      <DisplayRule Id="Mscrm.SingleQualifyStatusCode">
        <OptionSetRule OptionSet="lead_statuscode" StateCode="1" ObjectTypeCode="4" />
      </DisplayRule>
    </DisplayRules>
    <EnableRules>
      <EnableRule Id="Mscrm.LeadIsOpen">
        <FormStateRule State="Existing" />
      </EnableRule>
      <EnableRule Id="Mscrm.Form.lead.IsUCI">
        <CustomRule FunctionName="ClientUtility.ClientUtil.isUCI" Library="$webresource:MarketingSales/Lead/Lead_main_system_library.js" />
      </EnableRule>
      <EnableRule Id="Mscrm.IsEntityAvailableForUserInMocaOffline">
        <CustomRule FunctionName="XrmCore.Rules.Online.IsEntityAvailableForUserInMocaOffline" Library="$webresource:Main_system_library.js">
          <CrmParameter Value="SelectedEntityTypeName" />
        </CustomRule>
      </EnableRule>
      <EnableRule Id="Mscrm.IsAccountAvailableInMocaOffline">
        <CustomRule FunctionName="XrmCore.Rules.Online.IsEntityAvailableForUserInMocaOffline" Library="$webresource:Main_system_library.js">
          <StringParameter Value="account" />
        </CustomRule>
      </EnableRule>
      <EnableRule Id="Mscrm.IsContactAvailableInMocaOffline">
        <CustomRule FunctionName="XrmCore.Rules.Online.IsEntityAvailableForUserInMocaOffline" Library="$webresource:Main_system_library.js">
          <StringParameter Value="contact" />
        </CustomRule>
      </EnableRule>
      <EnableRule Id="Mscrm.IsOpportunityAvailableInMocaOffline">
        <CustomRule FunctionName="XrmCore.Rules.Online.IsEntityAvailableForUserInMocaOffline" Library="$webresource:Main_system_library.js">
          <StringParameter Value="opportunity" />
        </CustomRule>
      </EnableRule>
      <EnableRule Id="Mscrm.Form.lead.IsNotUCI">
        <CustomRule FunctionName="ClientUtility.ClientUtil.isUCI" Library="$webresource:MarketingSales/Lead/Lead_main_system_library.js" InvertResult="true" />
      </EnableRule>
      <EnableRule Id="paz.lead.EnableRule.HasRole">
        <CustomRule FunctionName="isNaN" Library="$webresource:paz_/lib/WebApiClient.js" Default="true" />
        <CustomRule FunctionName="formLead.HasRole" Library="$webresource:paz_/entities/Lead.js">
          <StringParameter Value="Qualify Lead" />
        </CustomRule>
      </EnableRule>
    </EnableRules>
  </RuleDefinitions>
  <LocLabels />
</RibbonDiffXml>