Predefined Filters

Learn how to set up a predefined filter which can be applied to a search in Apex API, Rest API, or the Direct Processing API. By doing that, you can do a search within a subset of data.
The use of Predefined Filters is only available in our 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)
 

Having trouble?

Our support agents are ready to help you !