Comment unsuccessful. Please correct the errors below.

Filtering lookup data in CRM 4

Now we all know that when Microsoft says "unsupported" they always sometimes mean business. Take, for example, popular CRM 3 customisation to filter lookup field data that used to work well. Until version 4, that is. Not all is lost, however, because no thanks to me but to Adi Katz, now there is new unsupported way to make it work in CRM 4 as well.

For example, to make primary contact lookup for an account record to show contacts from this account only, the following customizations are required:

[more]

Form OnLoad script

The script looks almost identical to the original one except for one very important change. We have to pass fetch xml string using one of the parameters recognised by the server otherwise exception is thrown (there is a way to disable parameters check through the registry setting DisableParameterFilter, but it's easier without yet another undocumented setting). Since we want to disable search functionality it makes sense to re-use search parameter.


var field = crmForm.all.primarycontactid;
if(crmForm.ObjectId == null)
{
    // Disable lookup for new account record as there can be no contacts
    field.Disabled = true;
}
else
{
    // Ensure that search box is not visible in a lookup dialog
    field.lookupbrowse = 1;
   
    // Pass fetch xml through search value parameter
    field.AddParam("search",
     "<fetch mapping='logical'><entity name='contact'>"
    + "<filter><condition attribute='parentcustomerid' operator='eq' value='"
    + crmForm.ObjectId
    + "' /></filter></entity></fetch>");
}

Field properties

If automatic resolution for the field is enabled and user types something in the field, it causes direct web service call that would ignore our fetch xml. In other words, user would be able to set the field value to any of the contacts in the database by simply typing contact's name. Disabling automatic resolution solves the issue:

Field properties dialog

Lookup dialog

Turns out, grid control in version 4 still recognises fetch xml, the challenge was to pass it. Kudos to Adi for finding a very clever workaround to inject fetch xml directly. The following code needs to be inserted anywhere in the <CRM site folder>\_controls\lookup\lookupsingle.aspx file.


<script runat="server">

protected override void OnLoad( EventArgs e )
{
      base.OnLoad(e);
      crmGrid.PreRender += new EventHandler( crmgrid_PreRender );
}

void crmgrid_PreRender( object sender , EventArgs e )
{
    // As we don't want to break any other lookups, ensure that we use workaround only if
    // search parameter set to fetch xml.
    if (crmGrid.Parameters["search"] != null && crmGrid.Parameters["search"].StartsWith("<fetch"))
    {
        crmGrid.Parameters.Add("fetchxml", crmGrid.Parameters["search"]); 

        // searchvalue needs to be removed as it's typically set to a wildcard '*'
        crmGrid.Parameters.Remove("searchvalue"); 

        // Icing on a cake - ensure that user cannot create new contact outside of the account
        // and then select it.
        this._showNewButton = false;
    }
}

</script>

 

You are on your own

I cannot stress enough that this customisation is 100% unsupported so use it at your own peril. In particular, because server files were modified, there is a good chance that you'll see yellow screen of death on a regular basis (if you've switched DevErrors on, that is). Much easier, supported way to achieve the same functionality (and much more) is to use custom lookup dialog from Michael Höhne.

Happy hacking!

Posted by: George Doubinski
Last revised: 05 Dec, 2012 05:26 PM

Comments

nike40
nike40
28 May, 2014 11:33 AM

Thank you so much for putting up a very good comparison on CRM3 version and the latest one. The users will not be much used with the latest version so I think the codes and algorithms here will be helpful for all. Good post fashion for play

Tony
Tony
17 Jul, 2014 01:33 PM

I'm gonna use this scripts to solve my problems with the updated version. I had just bookmarked this page, as I got a lot of useful information from this page. Thanks. Regards, [apple.com][1]

[1]: apple.com

antonubanderas
antonubanderas
18 Aug, 2014 07:47 AM

I am so glad to see the great tribute here. So much good has come from her great work. So many looked up to here so much. Glad this was offered. whiterock real estate

Jonah
Jonah
06 Sep, 2014 12:35 PM

I've faced a few issues through updating my CRM data and I've been searching for the perfect solutions since ages. But the above article had resolved my problems and I'm glad that I could make it up. Thanks for the share. Regards, ghost writer

Your Comments

Comment unsuccessful. Please correct the errors below.
Used for your gravatar. Not required. Will not be public.
Posting code? Indent it by four spaces to make it look nice. Learn more about Markdown.

Preview