Predefined Filters

Last published at: 2022-08-09 10:01:23 UTC

Use a predefined filter to search within a subset of data.

Predefined filters can be applied in a number of places, such as in a DC Job filter, in the Overall Job Results, in the Embedded Overall Job Results, or in a search in Apex API, Rest API, or the Direct Processing API. 


Predefined filters for custom objects

To use predefined filters for custom objects, you need to configure two additional fields. See How to use a pre-defined filter on a custom object results list‍ for more information on how to set them up.


Predefined Filters are only available in the Premium edition.

You can define a predefined filter per object at the DC Setup page, at the "Predefined Filter" tab. 

Adding a new Predefined Filter

You can add a new Predefined Filter by clicking the "Add Filter" button on the top-right of the page. 

Configuring a Predefined Filter

Configure a predefined filter by adding one or multiple fields, together with defining an expression and a value. Each defined field is referred to by a "filter line", which can be used on defining the filter logic. You can add a new filter line by clicking the "+" icon. 

Filter Logic 

In defining a filter logic, you can decide how the filter should be applied. Enter each filter line number, separated by a filter logic operator. For example, (1 AND 2) OR 3 finds records that match both Filter 1 and Filter 2, or Filter 3.

In the below example, we entered 2 filter lines and created a logic that both filter lines should equal the given value: (1 AND 2).

Apply the filter in an API Search

The filters can be used in the Apex API. The developername is needed for this. These methods in the dupcheck.dc3Api are available for predefined filters.

  • doSearchWithFilter (Sobject objectData, String filterDeveloperName)
  • doSearchWithFilter (Id objectId, String filterDeveloperName)
  • doSearchWithFilter (Map<String, Object> objectData, String objectPrefix, String filterDeveloperName)
  • doDirectProcess(Id recordId, String filterDeveloperName)