filter
filter actionManagement [Deprecated]
This is an object within which you can place filters that are intended to be used only with Action Management
filter actionManagementDate [Deprecated]
This creates a Date filter that can only be used with Action Management
filter contactEmailList
Sampling contact email list filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
allowedDomains |
List of allowed domains |
|||||
default |
Preselect owner team as a default values |
ownerteam |
||||
question |
Variable name for hierarchy link |
|
filter contacts
Sampling contacts filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
default |
Preselect owner team as a default values |
ownerteam |
||||
question |
Variable name for hierarchy link |
|
||||
restrictByNodeAssignments |
Switch to use end user restrictions |
true | false |
filter date
This object creates a Date filter, allowing the user to select a date range.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
dateVariables |
This property defines data fields for the date filter |
|
|
|||
filterGroups |
This property specifies the visibility of the quick options group. |
days,weeks,months,quarters,years,user,custom |
days | weeks | months | quarters | years | user | custom |
|
||
filterType |
This determines whether the filter is to be applied before or after rollup aggregation |
normal |
normal | postAggregate |
|||
hide |
This specifies that the filter will not be visible in the toolbar and filter panel. Note that the filter will still be applied (true | false). |
false |
true | false |
|||
hideInPanel |
This specifies that the filter will not be visible in the filter panel. Note that the filter will still be applied (true | false). |
true | false |
||||
hidePill |
This specifies that the filter will not be visible in the toolbar. Note that the filter will still be applied (true | false). |
true | false |
||||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|
||||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
||||||
Scope associated with this filter |
||||||
This property specifies the custom quick option |
||||||
This property specifies the custom quick option |
||||||
This property specifies the custom quick option |
||||||
This property specifies the custom quick option |
||||||
This property specifies the custom quick option |
||||||
This property specifies the custom quick option |
||||||
This property specifies the custom quick option |
||||||
This property specifies the custom quick option |
scope
Scope associated with this filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Defining a scope filter name |
|
||||
value |
Defining a scope filter value |
dateOption InYear
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseDate |
||||||
end |
|
|||||
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
|||
start |
|
dateOption InQuarter
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseDate |
||||||
end |
|
|||||
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
|||
start |
|
dateOption InMonth
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseDate |
||||||
end |
|
|||||
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
|||
start |
|
dateOption InFullWeek
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
baseDate |
||||||
end |
|
|||||
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
|||
start |
|
dateOption YearToDate
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
dateOption QuarterToDate
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
dateOption MonthToDate
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
dateOption FullWeekToDate
This property specifies the custom quick option
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Input the text string you want to be presented as the label for this filter option. |
|
||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
filter drillDown
Drill down filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
drillDown |
Drill down |
|
|
|||
filterType |
This determines whether the filter is to be applied before or after rollup aggregation |
normal |
normal | postAggregate |
|||
hide |
This specifies that the filter will not be visible in the toolbar and filter panel. Note that the filter will still be applied (true | false). |
false |
true | false |
|||
hideInPanel |
This specifies that the filter will not be visible in the filter panel. Note that the filter will still be applied (true | false). |
true | false |
||||
hidePill |
This specifies that the filter will not be visible in the toolbar. Note that the filter will still be applied (true | false). |
true | false |
||||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|
||||
root |
This specifies the root of the drill-down filter. It accepts one or more drill-down keys. Drill-down keys are the strings, separated by commas (,). Each drill-down key may contain one or more level keys separated by slashes (/) |
|
||||
smartExpand |
When this option is enabled, if there is only one element at the top of the hierarchy, the next level will be automatically expanded. |
true |
true | false |
|||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
||||||
Scope associated with this filter |
filter emaillist
Sampling paste emails list
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
allowedDomains |
List of allowed domains |
filter exclusion
Sampling exclusion filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
contacts |
Exclude owner contact from sampling |
owner |
||||
surveys |
Exclude surveys from sampling |
none |
filter expression
Expression filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
filterType |
This determines whether the filter is to be applied before or after rollup aggregation |
normal |
normal | postAggregate |
|||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|
||||
value |
Filter expression value |
|
||||
Scope associated with this filter |
filter expression
Filter that must be true for the operation to be executed
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
value |
Filter expression |
|
filter hierarchy
Sampling hierarchy selector
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
default |
Preselect owner team as a default values |
ownerteam |
||||
question |
Variable name to get hierarchy node value |
|
||||
restrictByNodeAssignments |
Switch to use end user restrictions |
true | false |
filter hierarchy
Here you define the Hierarchy filter settings. This allows you to set filtering by hierarchical variable, expand node records, select child records as a filter options etc
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
default |
Here you can add filter options that will then be selected by default when the data is initially loaded. |
|||||
filterType |
This determines whether the filter is to be applied before or after rollup aggregation |
normal |
normal | postAggregate |
|||
hide |
This specifies that the filter will not be visible in the toolbar and filter panel. Note that the filter will still be applied (true | false). |
false |
true | false |
|||
hideInPanel |
This specifies that the filter will not be visible in the filter panel. Note that the filter will still be applied (true | false). |
true | false |
||||
hidePill |
This specifies that the filter will not be visible in the toolbar. Note that the filter will still be applied (true | false). |
true | false |
||||
hierarchy |
Hierarchical field (vpath) – this is a field used to define parent-child relations when building the filter options tree (example - accounts:ParentAccountID) |
|
|
|||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|
||||
maxSearchResults |
Specify the maximum number of rows returned by the search |
10 |
|
|||
optionLabel |
Formula or question ID / alias |
|
|
|||
root |
This specifies the root of the hierarchy filter. It accepts the value from the field specified in the |
|
||||
smartExpand |
When this option is enabled, if there is only one element at the top of the hierarchy, the next level will be automatically expanded. |
true |
true | false |
|||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
||||||
Scope associated with this filter |
filter multiselect
Creates a Multi-Select filter. This type allows the user to select several filter options.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
default |
Here you can add filter options that will then be selected by default when the data is initially loaded. |
|||||
filterType |
This determines whether the filter is to be applied before or after rollup aggregation |
normal |
normal | postAggregate |
|||
hide |
This specifies that the filter will not be visible in the toolbar and filter panel. Note that the filter will still be applied (true | false). |
false |
true | false |
|||
hideInPanel |
This specifies that the filter will not be visible in the filter panel. Note that the filter will still be applied (true | false). |
true | false |
||||
hidePill |
This specifies that the filter will not be visible in the toolbar. Note that the filter will still be applied (true | false). |
true | false |
||||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|
||||
maxSearchResults |
Specify the maximum number of rows returned by the search |
100 |
|
|||
optionsFrom |
Select the question that the filter is to be based on (vpath). The categories (groups) from this question will be used as the filter options. |
|
||||
sortOrder |
Filter options sort order |
ascending | descending | reverse |
||||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
||||||
Scope associated with this filter |
||||||
Here you input the options you want to use for the filter, e.g. checkbox. You can add multiple checkboxes to a filter; each will need a unique name, a value and a label. |
||||||
Expression filter |
|
scope
Scope associated with this filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Defining a scope filter name |
|
||||
value |
Defining a scope filter value |
option checkbox
Here you input the options you want to use for the filter, e.g. checkbox. You can add multiple checkboxes to a filter; each will need a unique name, a value and a label.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Input the text string you want to be presented as the label for this filter option. |
|||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
|||
value |
This must be a condition; an expression that returns true or false. If this filter option is selected, the condition determines whether the record satisfies this filter option and thereby is to be included. |
|
[[filter.multiselect .sampling_multiselectFilter]] == filter multiselect Sampling multi select filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
question |
Variable name to base filter on |
|
filter reportingHierarchy
Reporting hierarchy filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
dynamicDataMode |
Hierarchy mode to use if 'useDynamicFilters' is set to true |
rollup | direct |
||||
dynamicDataTable |
Table to use when 'useDynamicFilters' is set to true |
|||||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|||||
maxSearchResults |
Specify the maximum number of rows returned by the search |
10 |
||||
mode |
This property is responsible whether reporting hierarchy filter should have single or multi select |
multiSelect |
multiSelect | singleSelect |
|
||
reportingHierarchy |
Reporting hierarchy name |
|
||||
smartExpand |
When this option is enabled, if there is only one element at the top of the hierarchy, the next level will be automatically expanded. |
true |
true | false |
|||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
filter reportingPeriod
Reporting period filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
hide |
This specifies that the filter will not be visible in the toolbar and filter panel. Note that the filter will still be applied (true | false). |
false |
true | false |
|||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
filter set
Page filters set by the runtime
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
summaryText |
Summary text for a page |
filter singleselect
This object creates a Single-Select filter. This type allows the user to select only one filter option.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
canClear |
If set to false, the filter Clear button is deactivated and the user cannot clear the filter (you may want one filter option always to be applied) (true | false). |
true |
true | false |
|
||
default |
Here you can add filter options that will then be selected by default when the data is initially loaded. |
|||||
filterType |
This determines whether the filter is to be applied before or after rollup aggregation |
normal |
normal | postAggregate |
|||
hide |
This specifies that the filter will not be visible in the toolbar and filter panel. Note that the filter will still be applied (true | false). |
false |
true | false |
|||
hideInPanel |
This specifies that the filter will not be visible in the filter panel. Note that the filter will still be applied (true | false). |
true | false |
||||
hidePill |
This specifies that the filter will not be visible in the toolbar. Note that the filter will still be applied (true | false). |
true | false |
||||
label |
Input a text string that will be presented as the name of the filter in the filter panel. |
|
||||
maxSearchResults |
Specify the maximum number of rows returned by the search |
100 |
|
|||
optionsFrom |
Select the question that the filter is to be based on (vpath). The categories (groups) from this question will be used as the filter options. |
|
||||
sortOrder |
Filter options sort order |
ascending | descending | reverse |
||||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
||||||
Scope associated with this filter |
||||||
Here you input the options you want to use for the filter, e.g. checkbox. You can add multiple checkboxes to a filter; each will need a unique name, a value and a label. |
||||||
Here you input the options you want to use for the filter, e.g. checkbox. You can add multiple checkboxes to a filter; each will need a unique name, a value and a label. |
||||||
Expression filter |
|
scope
Scope associated with this filter
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
name |
Defining a scope filter name |
|
||||
value |
Defining a scope filter value |
option checkbox
Here you input the options you want to use for the filter, e.g. checkbox. You can add multiple checkboxes to a filter; each will need a unique name, a value and a label.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Input the text string you want to be presented as the label for this filter option. |
|||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
|||
value |
This must be a condition; an expression that returns true or false. If this filter option is selected, the condition determines whether the record satisfies this filter option and thereby is to be included. |
|
option radio
Here you input the options you want to use for the filter, e.g. checkbox. You can add multiple checkboxes to a filter; each will need a unique name, a value and a label.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
label |
Input the text string you want to be presented as the label for this filter option. |
|||||
selected |
Add this property if you want to specify whether or not the filter option is selected by default (true | false). |
false |
true | false |
|||
value |
This must be a condition; an expression that returns true or false. If this filter option is selected, the condition determines whether the record satisfies this filter option and thereby is to be included. |
|