Override Global Settings

Status

Release Available	Status	Framework Name
3.5	Current	Mui and Mint
4.3	Current	Mui and Mint

General

The global setting can be overwritten by an actor appearance

Code JSON

Copy

"filters": {
  "keyword": {
    "filterLabel": "…",
    "fieldNames": […]
    
  },
  "advanced": {
    "dialogTitle": "Filters",
    "icon": "filter_list",
    "label": "Filtered by",
    "clearAllText": "Clear All",
    "startDateLabel": "Start date",
    "endDateLabel": "End date",
    "minNumberLabel": "Minumum",
    "maxNumberLabel": "Maximum",
    "toLabel": "to",
    "fromLabel": "from",
    "orLabel": "or",
    "clearLabel": "Clear",
    "applyLabel": "Apply",
    "notSpecifiedLabel": "Not specified",
    "invalidText": "Invalid value",
    "filterFields": [...]
    
  }
}

Keyword filtering is against text-base fields

Code JSON

Copy

"filters": {
  "keyword": {
    "fieldNames": [
      "Name",
      "Account.Name"      ]
    
  }
}

Advanced filtering is specified in a filter dialog

Code JSON

Copy

"filters": {
  "keyword": {
    "fieldNames": [...]
    
  },
  "advanced": {
    "filterFields": […]
    
  }
}

Fields with the type of date, number, currency, and percent can be added to the filtering dialog
- With two input fields, one for the minimum value and the other for the maximum value

Code JSON

Copy

"filters": {"advanced": {
  "filterFields": [{
    "fieldName": "Birthdate",
    "min": "$global.attr(minContactDob);",
    "minLabel": "Start date (no earlier than $global.attr(minContactDob, date, 'MM/dd/yyyy');)",
    "maxLabel": "End date",
    "minError": "Start date should not be earlier than $global.attr(minContactDob, date, 'MM/dd/yyyy');.",
    "minmaxError": "Start date should not be later than end date.",
    "maxminError": "End date should not be earlier than start date.",
    "fieldUi": {
      "settingsOptions": { "fieldFormat": "MM/dd/yyyy" },
      "format": { "options": { "datePattern": "MM/dd/yyyy" }}
      
    }},

min, max: specify the minimum or maximum limit
minLabel, maxLabel: labels for the minimum and maximum inputs
minError, maxError: error messages if the min value is less than the min limit or if the max value is greater than the max limit.
minmaxError, maxminError: error messages if the min value is greater than the max value

In fieldUi

settingsOptionsis for the chip display.
format.options is for the dialog input.

Code JSON

Copy

"filters": {"advanced": {
  "filterFields": [{
    "fieldName": "Account.AnnualRevenue",
    "min": "$global.attr(minRevenue);", "max": "$global.attr(maxRevenue);",
    "minLabel": "Minimum revenue (no less than $global.attr(minRevenue, currency);)",
    "maxLabel": "Maximum revenue (no greater than $global.attr(maxRevenue, currency);)",
    "minError": "Invalid minimum revenue","maxError": "Invalid maximum revenue",
    "minmaxError": "Minimum amount should not be larger than maximum amount.",
    "maxminError": "Maximum amount should not be smaller than minimum amount.",
    "fieldUi": {
      "settingsOptions": { "maximumFractionDigits": 0, "minimumFractionDigits": 0 },
      "format": {
        "options": {
          "numeral": true,
          "numeralThousandsGroupStyle": "thousand",
          "numeralDecimalScale": 0
          
        },
        "prefix": "$"        
      }
      
    }
    
  }, {
    "fieldName": "Birthdate",
    "fieldUi": {
      "settingsOptions": { "fieldFormat": "MM/dd/yyyy" },
      "format": { "options": { "datePattern": "MM/dd/yyyy" }}
      
    }

Fields with the type of picklist, radiobuttons, and selectbuttons can be added to the filtering dialog

You can specify whether multiple option values can be selected. The record matches one value is kept.

Code JSON

Copy

"filters": {
  "advanced": {
    "filterFields": [{
      "fieldName": "clcommon__Marital_Status__c",
      "allowMultiple": true
      
    },

Fields with the type of boolean, switch, and toggle can be added to the filtering dialog

As a picklist with the "not specified" text, the "true" text, and the "false" text

Code JSON

Copy

"filters": {
  "advanced": {
    "filterFields": [{
      "fieldName": "clcommon__Not_A_Citizen__c",
      "trueLabel": "true",
      "falseLabel": "false"      
    },

Chips can be cleared one by one or be cleared altogether by clicking the Clear All link.

Note:

With the Portal 4.3 release, the Clear All link is accessible and can be interacted with the Keyboard keys.

Chips and keyword filtering are combined.

Mobile UI (Mui only)

Filtering (Mint)

Code JSON

Copy

"settings": {
  "filters": {
    "icon": "fa-filter"  }
}

Override Global Settings

Mobile UI (Mui only)

Filtering (Mint)

In This Article