Create Reports with Custom Apex Filter

Along with standard filters, you can also define custom Apex filters that reference the attributes of the Promotion object.

Core examples are filtering by the promotion type and phase of the promotion. A custom example is linking one promotion to one specific event.

With that, the main benefit of a custom Apex filter is to offer the opportunity to filter promotions by promotion attributes that aren’t covered by standard filters. In addition to that, if all the values of the standard filter aren’t visible, you can limit the available filter values of a promotion attribute for a specific real-time report.

Custom Apex filters work only with single-select picklists, not with multi-select picklists.

Note

Report Configuration

In the report configuration, ensure that you define the custom Apex filters in the same section as standard filters.

You can’t use a standard and custom filter with the same name (for example, promo_templatesfid) in the same report configuration.

Note

Example

1{
2"type": "singleselect",
3"label": "Promotion Type",
4"name": "promo_templatesfid",
5"source": {
6"class": "TPM_RTRPromoTypeFilter_AMS",
7"method": "Event"
8},
9"defaultValue": "<<FIRST_VALUE>>"

Here, method is the name of a parameter. This parameter is the Developer_Name__c field of a metadata type record.

However, you can also write a filter without parameters and discard the method line and modify the Apex code accordingly.

Apex Class

To implement the new filter logic, create an Apex class. You can construct the code for all Apex filters as specified here:

Implement System.Callable.
Retrieve the user’s sales organization for later use.
Define the custom logic that returns a map with values.
Define a public object call that the report always initially calls. When the public object is called, it calls the method with the custom logic and passes a string parameter (based on the value of method in the report configuration).