Custom Metadata Setup

The CMDT Filter feature enables filtering of lookup fields in the Add/Edit lightning modals and Download/Upload Templates using CMDT filters. It introduces a new Custom Metadata Type (CMDT) named xx_Lookup_Filter_Label_Mapping_mdt, designed to streamline the lookup process with specific conditions.

CMDT Structure

The CMDT includes the following fields:

Source Component (Picklist): xx_Source_Component__c
Child Object (Text): xx_Child_Object__c
Parent Object (Text): xx_Parent_Object__c
Lookup Field on the Child Object (Text): xx_Related_Lookup__c
Filter Condition (Text): xx_Filter_Condition__c
Label Field API Name (Text): xx_Child_Label_Name__c
IsActive (Boolean): xx__isActive__c

In Label Field API Name (Text) → xx_Child_Label_Name__c please enter the API name with a supported data type.

Supported Data Types include:

Email
Phone
Picklist
Text
Text Area
URL
Lookup

If there are no records with a value in the field specified by the Label Field API Name → (xx_Child_Label_Name__c), those records won’t appear in the results. Only records with a value in the field defined by the Label Field API Name will be displayed.

Filter Condition Format

The following types of conditions are supported:

Operator(Parent_Field_API, VALUE(Constant Value))
Operator(Parent_Field_API, FIELD(Child_Field_API))

The xx_Filter_Condition__c field requires specific formatting for conditions. Supported condition types include:

Complex Conditions:
- AND Condition: AND(Condition1;Condition2)
  - Example: AND(EQUALS(projectAccountType__cFIELD(Account.Type)); EQUALS(projectAccountId__cFIELD(Account.Id)))
- OR Condition: OR(Condition1;Condition2)
  - Example: OR(EQUALS(projectAccountType__cFIELD(Account.Type)); EQUALS(projectAccountId__cFIELD(Account.Id)))

Conditions should be separated by a semicolon (;).

Simple Condition:
- Example: EQUALS(projectAccountType__cFIELD(Account.Type))

Supported Data Types and Operators

The following data types and their corresponding operators are supported for CMDT filters:

Data Type	Operator Label	Operator Value
Phone	EQUALS	`=`
	NOTEQUALS	`!=`
	CONTAINS	`LIKE`
	NOTCONTAINS	`NOT LIKE`
Text Picklist	EQUALS	`=`
	NOTEQUALS	`!=`
	CONTAINS	`LIKE`
	NOTCONTAINS	`NOT LIKE`
Date, Number, Currency, Percent	EQUALS	`=`
	NOTEQUALS	`!=`
	LESSTHAN	`<`
	GREATERTHAN	`>`
	LESSTHANEQUAL	`<=`
	GREATERTHANEQUAL	`>=`

In the Add modal, when using the operators LESSTHAN, GREATERTHAN, LESSTHANEQUAL, or GREATERTHANEQUAL with a Field-type filter, the field must be included in the modal and must contain a value. In the case of Value it works fine, irrespective.

Similarly, in the Edit modal, if you're using the operators LESSTHAN, GREATERTHAN, LESSTHANEQUAL, or GREATERTHANEQUAL with a Field-type filter, the field must have a value. In the case of Value it works fine, irrespective.

Filter Validation and Limitations

Phone Data Type: Values must be passed in an unformatted way (e.g., 1234567891), but will be displayed as formatted (123) 456-7891.
Date Data Type: Values must follow the YYYY-MM-DD format.
Currency and Number Fields: If no value is provided during add/edit operations, the system defaults to 0 for comparisons.
Date Fields: If no value is entered, the system treats it as null during comparisons.
When downloading Activities from the Implementation Plan record page, only fields from the host object (Implementation Plan) can be used for filtering.

The last limitation applies to other download scenarios, Activities and Implementation plan have only been used for representational purposes.

Usage Scenarios

When working with standard objects, we use the object’s API name followed by .Id for comparisons, although other field APIs can also be used if necessary.

Standard Lookup Field Traversal: Remove the "Id" from the lookup field API name (e.g., CreatedById becomes CreatedBy.Name).
Custom Lookup Field Traversal: Replace __c with __r (e.g., ampi__Project__c becomes ampi__Project__r.Name).

Dynamic Search Filter (DSF)

The DSF supports only the Label Field API Name (xx_Child_Label_Name__c) for filtering. Only records with values in this field will appear in the lookup dropdown.

User Permissions

Editable Fields: Users can edit only the IsActive field and the Filter Condition.
Non-editable Fields: Remaining fields cannot be modified by the user.

Error Handling

Invalid Filter: An error is raised if the filter conditions are incorrect.
API Errors: Errors occur if any API referenced in the filter is unavailable.
Field Access Issues: If there is no access to a specified field in the filter, it will trigger an error.
LWC Components: If one filter fails, the default values will display, ignoring all other valid filters.
Download/Upload: If one filter fails, the remaining valid filters are still applied to their respective lookups.