Properties of a Filter

{
"type":
"multiselect",
"name":
"accountsfids",
"label":
"Accounts",
"source":
"PlanAccounts"
}

{
"type":
"multiselect",
"label":
"Categories",
"level": "category",
"name":
"productsfids",
"source": "Products"
}

{"
type":
"singleselect",
"name":
"productlevel",
"label":
"Product Level",
"source":
"ProductDimension"
}

{
"type": "singleselect",
"name": "kpigroup",
"label": "Measure
group",
"source": "KPIGroup"
}

{"
type":
"subaccount",
"name":
"subaccountsfids",
"label":
"Sub Accounts",
"accountfilter":
"accountsfids",
"source":
"SubAccounts"
}

{
"type":
"multiselect",
"label": "Promotion
Template",
"name":
"promo_templatesfid",
"source":
"PromotionTemplate"
}

{
"type": "multiselect",
"label": "Promotion Phase",
"name": "promo_phase",
"source":
"PromotionPhase"
}

{"
label":
"Period",
"source":
"PeriodYear",
"name":
"periodyear",
"type":
"singleselect"
}

{
"label": "Period",
"type":
"periodmonth",
"name": "periodmonth"
}

{
"label": "Period",
"type": "periodweek",
"name": "periodweek"
}

{
"type": "singleselect",
"name": "promo_timeframe",
"label": "Promotion Time Frame",
"values": [
    {
        "label": "Default"
        "value": "default"
    },
    {
        "label": "Overlapping"
        "value": "overlapping"
    },
    {
        "label": "Including"
        "value": "including"
    }
           ]
}

To filter data based on attributes of promotion, use any attribute from the promotion dimension as a filter. To use an attribute from promotion dimension, maintain the attribute in promotion dimension with its attribute name and label. Here’s an example of promotion dimension.

[
{
"sortenum": [
"initial",
"Planning",
"Commited",
"Canceled"
],
"fielddb$label": "phase",
"fieldsf$label": "ACCL__Phase__c",
"fielddb": "phase",
"fieldsf": "ACCL__Phase__c",
"name": "phase"
},
{
"fielddb$label": "Slogan",
"fieldsf$label": "ACCL__Slogan__c",
"fielddb": "phase",
"fieldsf": "ACCL__Slogan__c",
"name": "slogan"
},
{
"fieldsf$label": "ACCL__Promotion_Template__r.ACCL__Description__c",
"fieldsf": "ACCL__Promotion_Template__r.Id",
"name": "type"
},
{
"fieldsf$label": "ACCL__Promotion_Template__r.ACCL__Product_Definition_Level__c",
"fieldsf": "ACCL__Promotion_Template__r.ACCL__Product_Definition_Level__c",
"name": "productdeflevel"
},
{
"fieldsf$label": "ACCL__Date_From__c",
"fieldsf": "ACCL__Date_From__c",
"name": "datefrom"
},
{"fieldsf$label": "ACCL__Date_Thru__c",
"fieldsf": "ACCL__Date_Thru__c",
"name": "datethru"
},
{
"fieldsf$label": "ACCL__Delivery_Date_From__c",
"fieldsf": "ACCL__Delivery_Date_From__c",
"name": "instoredatefrom"
},
{
"fieldsf$label": "ACCL__Delivery_Date_Thru__c",
"fieldsf": "ACCL__Delivery_Date_Thru__c",
"name": "instoredatethru"
},
{
"fieldsf": "ACCL__Count_Tactics__c",
"fieldsf$label": "ACCL__Count_Tactics__c",
"name": "tacticcount"
},
{
"fieldsf": "ACCL__Is_Frozen__c",
"fieldsf$label": "ACCL__Is_Frozen__c",
"name": "isFrozen"
},
{
"fieldsf": "Id",
"fieldsf$label": "Name",
"name": "id"
}
]

Here’s an example of a filter configuration to add a product definition level filter where products are maintained at promotion or tactic level.

{
"type": "singleselect",
"name": "promo_s_productdeflevel",
"label": "ProductDefinitionLevel",
"values": [
{
"label": "Promotion",
"value": "Promotion"
},
{
"label": "Tactic",
"value": "Tactic"
}
]
}

To add custom filters to a report that uses promotion dimension, create a filter by using the syntax:<prefix>_<valuetype>_<promodimensionmetaattributename>. Always use promo as the prefix. For promotion dimension attribute name, use the name of the promotion dimension. For value type, enter the type of the value, such as string.

FilterType

Here are the types of filters.

• singleselect: Use to restrict selection to only one value. Always provide a source with a set of values.
• multiselect: Use to allow selecting multiple values from a list. Always provide a source with a set of values.
• periodmonth: Use to specify the time frame in months as a filter.
• periodweek: Use to specify the time frame in weeks as a filter.
• hidden: To hide a filter in the UI. The value of this filter is always the defined default value.
• fixed: Use to add a filter that is visible on the UI but can’t be edited. The value of the filter is always the defined default value.
• subaccount: Use to show subaccounts based on the selected accounts.

FilterDefaultValue

The default value of a filter depends on the type of filter.

{"
defaultValue":
"<<ALL_VALUES>>"
}

{
{"
defaultValue": "<<FIRST_VALUE>>"
}

{"
defaultValue": "<<MIDDLE_VALUE>>"
}

"defaultValue": "<<LAST_VALUE>>"
}

{"
defaultValue": "<<FIRST_VALUE>>"
}

{"
defaultValue": {
"year":
"<<CURRENT_YEAR>>",
"start":
"<<CURRENT_MONTH>>",
"total" : 18
}}

{"
defaultValue": {
"year": 2019,
"start": 0,
"total" : 18
}}

FilterValues

Values for the selected filter types. The values include these attributes:

• label: The name of the filter value that’s shown.
• value: The possible values for the filter.
• accountsfld: Details of the main account of the subaccount that’s added as the filter. This field is mandatory only when the filter type is subaccount.

ValuesProvider

Represents the metadata required to request the filter values from an Apex class for select and multiselect filters. The metadata includes these attributes.

• class: The APEX class that calls filter values.
• method: The method that is passed to the Apex callable class on the action parameter. The default value is an empty string.
• params: The JSON object that is passed as parameters to the Apex callable class. The default value is an empty object.
• cacheable: Indicates whether the data of an APEX call must be cached. Use this setting to achieve better performance when you’re using data that doesn’t change often. The default value is false.
• labelField: Determines the returned objects to be used as a label for filter values. The default value is label.
• valueField: Determines the returned objects to be used as the value for the filter values. The default value is value.

Note For the class, labelField, and valueField attributes, use the <<NS__>> token in the string to dynamically resolve the cgcloud namespace. For example, a class attribute can be <<NS__>>TestClass CGCL__TestClass, and labelField and valueField attributes can be <<NS__>>Field1__c CGCloud__Field1__c.

ValuesSource

{"
name": "accountids",
"type": "multiselect",
"required": true,
"label": "Customers",
"source": "myCustomAPEXClass",
}

Use sources of filters together with the filter names that they’re linked to. For example, if the source is defined as subaccounts, use only the filters that are linked to the subaccounts. The possible value sources are:

• PlanAccounts: Generates values with all the accounts that you have access to.
• SubAccounts: Generates the subaccounts filter values for a subaccount filter based on
• Categories: Generates values with all the product categories that you have access to.
• Products: Generates values with all the products of the specified level that you have access to.
• KPIs: Generates values with all the KPIs that are included in a report.
• KPIGroup: Generates values with all the KPI groups that are included in a report.
• ProductDimension: Generates values with all the product dimensions that are included in
• TimeDimension: Generates values with all the time dimensions that are included in a report.
• PeriodYear: Generates five values until the current year.

accountfilter

{"
type": "singleselect",
"name": "accountsfids",
"label": "Accounts",
"source": "PlanAccounts"
}