Dynamically Filtering a Lookup on a Creatio Freedom UI Page

Hi Ryan, thanks for this guide, it’s worth noting that with the somewhat recent ability to configure applications to open lookup modal windows from “dropdown” fields in Freedom UI, that the request for this is different (and actually uses _both_ the one stated in this guide when using that field as a combo box where you type data in and autocomplete, and a different request for when opening the modal window, so code duplication may be required to filter both!) The one to look for is crt.OpenLookupPageRequest, and the filtering would have to be different – either on request.itemAttributeName = or request.itemsAttributeName = _List.

I would also be interested to know if you’ve found any workarounds for the refreshing of data – I wondered if adding a custom handler for crt.HandleViewModelAttributeChangeRequest to check if fields that impact the lookup filter have been changed and to executeRequest to reload the data source or reapply the filter in some way?

Thanks for your articles!

Hi Ryan,
thank you for your guides, they are always clear and informative!

Do you have any news about the fact that lookups only request their data once?
I think it is a serious limitation and I was wondering if in the meantime you had found another way to update the lookup or to filter it dynamically.

Please let me know.
Thanks!

Luca

Hi Ryan,

Thank you so much for this Article of yours it is very helpful as we couldn’t really get that much information related to coding in Creatio Academy. We are currently using version 8.1.1 and is not working. Maybe there is only something wrong with my code.

handlers: /**SCHEMA_HANDLERS*/[
{
request: “crt.LoadDataRequest”,
handler: async (request, next) => {
// filter the city lookup for the country

if(request.dataSourceName !== “PDS_UsrCity_d9j1nkq_List_DS”) {
return await next?.handle(request);
}

// get the country
const country = await request.$context.PDS_UsrCountry_0sp83x0;
if (country) {
const filter = new sdk.FilterGroup();
await filter.addSchemaColumnFilterWithParameter(sdk.ComparisonType.Equal, “Country”, country.value);

// note, these lines are only needed due to an issue with filters in Creatio-DevKit SDK
// expected to be fixed in Creatio 8.1
const newFilter = Object.assign({}, filter);
newFilter.items = filter.items;

request.parameters.push({
type: “filter”,
value: newFilter
});
}

return await next?.handle(request);
}
}
]/**SCHEMA_HANDLERS*/,

By the way, how you are doing the client side debugging in freedom ui? I tried to set breakpoint inside this “handlers” but it is not hit.

Hi Ryan, thanks for the guide!

Is there any UPD information how to update the contents of the combobox we are filtering? I implemented filtering according to the guide and it works once (unless we conditionally change the value of the element directly on the page), as you described. I encounter all sorts of difficulties in the new interface and I would like to learn how to solve them

Thanks in advance!

Harvey,

Did you get a lookup modal window to filter at all? The `request` parameter does not have a `parameters` attribute (i.e., `request.parameters`), and adding one doesn’t result in a filter that works.

Dear Ryan,

Why sometimes you use: return next?.handle(request);

And others like here: return await next?.handle(request);

Which is the difference, and when use one or the another?

Thanks in advance
Julio

Good afternoon. Could you please tell me what type the field should be to create a multiselect? Here is my version, but it’s not working because I don’t fully understand the structure.

{
				"operation": "insert",
				"name": "ComboBox_93g6gzn",
				"values": {
					"layoutConfig": {
						"column": 1,
						"row": 2,
						"colSpan": 1,
						"rowSpan": 1
					},
					"type": "crt.ComboBox",
					"label": "$Resources.Strings.PDS_GenContactRoles_57k55ma",
					"labelPosition": "auto",
					"control": "$PDS_GenContactRoles_57k55ma",
					"listActions": [],
					"showValueAsLink": true,
					"controlActions": []
				},
				"parentName": "GridContainer_035sekm",
				"propertyName": "items",
				"index": 2
			},  {
  "request": "usr.OpenLookupRequest",
  "handler": async (request, next) => {
    devkit.HandlerChainService.instance.process({
      type: "crt.OpenLookupPageRequest",
      scopes: [...request.scopes],
      $context: request.$context,
      entitySchemaName: "Contact", // Choose the correct entity schema
      schemaName: 'DefaultLookupPage', // Lookup schema
      itemAttributeName: 'ComboBox_asw7mde', // Item attribute name for multi-select
      afterClosed: (result) => {
        // Handling selected items for multi-select
        const selectedItems = result?.value ?? []; // result.value should contain the selected items
        alert(selectedItems.map(item => item.displayValue).join(", "));
      },
      filtersConfig: {
        filterAttributes: [
          {
            name: 'MyFilter',
            loadOnChange: false
          }
        ],
        attributesConfig: {
          MyFilter: {
            value: {
              "items": {
                "29e16d42-36f1-4e04-9029-4321cbb2494d": {
                  "filterType": 1,
                  "comparisonType": 11,
                  "isEnabled": true,
                  "trimDateTimeParameterToDate": false,
                  "leftExpression": {
                    "expressionType": 0,
                    "columnPath": "Name"
                  },
                  "isAggregative": false,
                  "dataValueType": 1,
                  "rightExpression": {
                    "expressionType": 2,
                    "parameter": {
                      "dataValueType": 1,
                      "value": "Super"
                    }
                  }
                }
              },
              "logicalOperation": 0,
              "isEnabled": true,
              "filterType": 6,
              "rootSchemaName": "Contact"
            }
          }
        }
      }
    });
    return next?.handle(request);
  }
}

It looks like you’ve mixed the request handler in with the UI element. The handler code as shown in this article goes in the page handlers area.

Hi Ryan,

Thank you for the article I found it very useful implementing. I just have question on if it is possible to implement this filter for more than one thing. I got the filter to work to where if a state was selected then it would filter the city based on the selected state but I have not gotten it to work for Countries. I want it to work to where if I selected a country it would filter both the city and the state based on the selected country. Is there anything that I am missing from here

handlers: /**SCHEMA_HANDLERS*/[ 
        {
            request: "crt.LoadDataRequest",
            handler: async (request, next) => 
            {
              // filter the contact lookup for the account
              if(request.dataSourceName !== "AccountAddressDS_City_tlnr1l3_List_DS") 
              {
                  return await next?.handle(request);
              }
              // get the state 
              const state = await request.$context.AccountAddressDS_Region_vbucljt;
              if (state) 
              {
                  const filter = new sdk.FilterGroup();
                  await filter.addSchemaColumnFilterWithParameter(sdk.ComparisonType.Equal, "Region", state.value);
 
                  // note, these lines are only needed due to an issue with filters in Creatio-DevKit SDK
                  // expected to be fixed in Creatio 8.1
                  const newFilter = Object.assign({}, filter);
                  newFilter.items = filter.items;
                  request.parameters.push({
                      type: "filter",
                      value: newFilter
                  });
                }
                return await next?.handle(request);
              }
            },
            {
                request: "crt.LoadDataRequest",
                handler: async (request, next) =>
                    {
                        // filter the contact lookup for the account for City
                        if(request.dataSourceName !== "AccountAddressDS_City_tlnr1l3_List_DS") 
                          {
                              return await next?.handle(request);
                          }
                        // filter the contact lookup for the account for State
                        if(request.dataSourceName !== "AccountAddressDS_Region_vbucljt_List_DS") 
                          {
                              return await next?.handle(request);
                          }

                        //get the country
                        const country = await request.$context.AccountAddressDS_Country_389yuds;
                        if (country)
                          {
                            const filter = new sdk.FilterGroup();
                            await filter.addSchemaColumnFilterWithParameter(sdk.ComparisonType.Equal, "Country", country.value);
 
                            // note, these lines are only needed due to an issue with filters in Creatio-DevKit SDK
                            // expected to be fixed in Creatio 8.1
                            const newFilter = Object.assign({}, filter);
                            newFilter.items = filter.items;
                            request.parameters.push({
                                  type: "filter",
                                  value: newFilter
                                }); 
                            }
                      return await next?.handle(request);
                    }
            }