CRM 2011: Filtered Lookup for Add Existing button for Many-to-many Relationship

Following up from the previous post , we want to take filtered lookup to ‘Add Existing’ button. Please note that this only works for a Many-to-many relationship.

To do this we need to replace the view (query and layout) of the ‘Add Existing’ button control. For this example we will use ‘Add Existing’ Account.

1. Query and Layout
Please refer to post for query and layout part.

2. Generic Javascript replace view function for ‘Add Existing’ button. Create web resource file for this eg. new_CustomAddExistingView

function replaceAddExistingButtonView(params) {
    var relName = params.gridControl.getParameter("relName"),
        roleOrd = params.gridControl.getParameter("roleOrd"),
        viewId = "{1DFB2B35-B07C-44D1-868D-258DEEAB88E2}"; //Random GUID
    
    var customView = {
        fetchXml: params.fetchXml,
        id: viewId, 
        layoutXml: params.layoutXml,
        name: params.name,
        recordType: params.gridTypeCode,
        Type: 0
    };

    var lookupItems = LookupObjects(null, "multi", params.gridTypeCode, 0, null, "", null, null, null, null, null, null, viewId, [customView]);
    if (lookupItems && lookupItems.items.length > 0) {
        AssociateObjects(crmFormSubmit.crmFormSubmitObjectType.value, crmFormSubmit.crmFormSubmitId.value, params.gridTypeCode, lookupItems, IsNull(roleOrd) || roleOrd == 2, "", relName);
    }
}

3. Function to call to replace ‘Add Existing’ Account button. Add this to new_CustomAddExistingView Web Resource file.

function replaceAddExistingButtonViewForAccount(gridTypeCode, gridControl) {
    replaceAddExistingButtonView({
        gridTypeCode: gridTypeCode,
        gridControl: gridControl,
        fetchXml: "<fetch version='1.0' output-format='xml-platform' mapping='logical' distinct='false'>" +
					  "<entity name='account'>" +
						"<attribute name='name' />" +
						"<attribute name='primarycontactid' />" +
						"<attribute name='telephone1' />" +
						"<attribute name='accountid' />" +
						"<order attribute='name' descending='false' />" +
						"<filter type='and'>" +
						  "<condition attribute='name' operator='like' value='Abc%' />" +
						"</filter>" +
					  "</entity>" +
					"</fetch>",
        layoutXml: "<grid name='resultset' object='1' jump='name' select='1' icon='1' preview='1'>" +
					  "<row name='result' id='accountid'>" +
						"<cell name='name' width='300' />" +
						"<cell name='primarycontactid' width='150' />" +
						"<cell name='telephone1' width='100' />" +
					  "</row>" +
					"</grid>",
		name: "Accounts Beginning with Abc"
    });
}

4. Export solution with ‘Account’ entity and look for Mscrm.AddExistingRecordFromSubGridAssociated. It should looks something like this:

<CommandDefinition Id="Mscrm.AddExistingRecordFromSubGridAssociated">
	<EnableRules>
	  <EnableRule Id="Mscrm.AppendPrimary" />
	  <EnableRule Id="Mscrm.AppendToPrimary" />
	  <EnableRule Id="Mscrm.EntityFormIsEnabled" />
	</EnableRules>
	<DisplayRules>
	  <DisplayRule Id="Mscrm.AddExisting" />
	  <DisplayRule Id="Mscrm.ShowForManyToManyGrids" />
	  <DisplayRule Id="Mscrm.AppendPrimary" />
	  <DisplayRule Id="Mscrm.AppendToPrimary" />
	  <DisplayRule Id="Mscrm.AppendSelected" />
	  <DisplayRule Id="Mscrm.AppendToSelected" />
	  <DisplayRule Id="Mscrm.CanWriteSelected" />
	</DisplayRules>
	<Actions />
</CommandDefinition>

Add new Action

<Actions>
  <JavaScriptFunction FunctionName="replaceAddExistingButtonViewForAccount" Library="$webresource:new_CustomAddExistingView">
	<CrmParameter Value="SelectedEntityTypeCode" />
	<CrmParameter Value="SelectedControl" />
  </JavaScriptFunction>
</Actions>

Add the above to RibbonDiffXml, it should look something like this

<RibbonDiffXml>
	<CustomActions />
	<Templates>
	  <RibbonTemplates Id="Mscrm.Templates"></RibbonTemplates>
	</Templates>
	<CommandDefinitions>
		<CommandDefinition Id="Mscrm.AddExistingRecordFromSubGridAssociated">
			<EnableRules>
			  <EnableRule Id="Mscrm.AppendPrimary" />
			  <EnableRule Id="Mscrm.AppendToPrimary" />
			  <EnableRule Id="Mscrm.EntityFormIsEnabled" />
			</EnableRules>
			<DisplayRules>
			  <DisplayRule Id="Mscrm.AddExisting" />
			  <DisplayRule Id="Mscrm.ShowForManyToManyGrids" />
			  <DisplayRule Id="Mscrm.AppendPrimary" />
			  <DisplayRule Id="Mscrm.AppendToPrimary" />
			  <DisplayRule Id="Mscrm.AppendSelected" />
			  <DisplayRule Id="Mscrm.AppendToSelected" />
			  <DisplayRule Id="Mscrm.CanWriteSelected" />
			</DisplayRules>
			<Actions>
			  <JavaScriptFunction FunctionName="replaceAddExistingButtonViewForAccount" Library="$webresource:new_CustomAddExistingView">
				<CrmParameter Value="SelectedEntityTypeCode" />
				<CrmParameter Value="SelectedControl" />
			  </JavaScriptFunction>
			</Actions>
		</CommandDefinition>
	</CommandDefinitions>
	<RuleDefinitions>
	  <TabDisplayRules />
	  <DisplayRules />
	  <EnableRules />
	</RuleDefinitions>
	<LocLabels />
</RibbonDiffXml>

5. Zip the solution files, import and publish.

Note: For One-to-Many relationship, read this post.

Cheers – Sy