Dynamics CRM Native Lookup with filtered view

Introduction

Well, we all know that dynamic CRM supports filtered view in Lookup that are opened from native lookup attribute or lookup control. This can be done by using addCustomFilter and addPreSearch Client APIs that are available. However, this has its own limitations. There is no proper reference or documentation that tells us how we can open a filtered lookup popup window without having attribute placed on the from.

Problem

Dynamics CRM Lookups can be called by constructing the URL and opening the same using Xrm.Internal.openDialog but, this cannot have filter dynamically added. To have a lookup popup from a custom webresource, that will filter default view based on certain criteria set programatically is not possible.

Solution

To solve this problem, I have created a custom method that opens a native lookup popup without any dependency. There is also a callback which can be used to get the record(s) selected by the user on the lookup.

Method needs

1. Object type code of the entity you are trying to open. In my case it was a custom entity.
2. Filter XML
3. Default view Id of the entity.

     function testLookUp()

     {

    var lookupObjectTypeCode = 10011; //entity object type code

    var fetchXml = "<filter type='and'><condition attribute='new_name' operator='like' value='%test%' /></filter>";

    var defViewId = "{325CB2BC-0307-4721-AA52-71F0570DFEF4}"; //your entity viewid

    openlookup(lookupObjectTypeCode, fetchXml, defViewId);

}

function openlookup(otc, filterXml, viewId)

{

   

    var currentObj = new Object();

    currentObj.currentObjectType = window.parent.Xrm.Internal.getEntityCode(window.parent.Xrm.Page.data.entity.getEntityName()).toString();

    currentObj.currentid = window.parent.Xrm.Page.data.entity.getId();

    var lookupObj = new window.parent.Xrm.LookupOptions();

    var arrLookuptype = new Array(1);

    arrLookuptype[0] = window.parent.Xrm.Internal.getEntityName(lookupObjectTypeCode);

    lookupObj.lookupStyle = "single";

    lookupObj.lookupTypes = arrLookuptype;

    lookupObj.defaultViewId = defViewId;

    lookupObj.additionalParams = currentObj;

    lookupObj.customViews = null;

    lookupObj.searchText = "";

    lookupObj.defaultType = lookupObjectTypeCode.toString();

    lookupObj.disableQuickFind = "1";

    lookupObj.showNew = false;

    lookupObj.viewIds =  null;

    lookupObj.disableViewPicker = true;

    lookupObj.filterRelationshipId = "";

    lookupObj.filterRelationshipName = null;

    lookupObj.filterRelationshipType = "";

    lookupObj.filterRelationshipDependantAttribute = null;

    lookupObj.allowFilterOff = false;

    lookupObj.customFilters = new Array(window.parent.CrmEncodeDecode.CrmUrlEncode(fetchXml));

    lookupObj.customFilterTypes = new Array("");

    window.parent.Xrm.Internal.lookupObjects(lookupObj, function (lookupItems) {

        if (lookupItems && lookupItems[0]) {

            alert(lookupItems[0].id + " " + lookupItems[0].name);

        }

    }, null);

}

Image shows filtered lookup from custom code

Disclaimer :

1. This is just a sample code for educational purpose. Use at your own risk.
2. Code further needs proper callback handling.
3. Code is tested in DCRM 2016, need little modification for DCRM 365