Filter properties

Control security

Setting	Description
Apply View Permission	Determines whether the View security permission will be applied when this filter control is displayed and used. When enabled, object security is applied when this filter control is rendered and used in @@PROMPT statements. When disabled (default), the object security is not applied.

Control style

These settings determine basic positioning and layout for the control.

Setting	Description
Control Type	Specifies the type of control to render for the filter interface. Drop Down: Displays a single selection drop-down list control. (Default) Text Box (basic): Displays a single value single or multi-row text entry control. When filtering child controls, the Text Box control matches either on an exact or on a partial match of the beginning of its parent value with this control's entered value. Single Select (Search/picker): Displays a single selection multi-row list control. Multi Select (Search/picker): Displays a multi-selection multi-row list control. Range Select (Slider/picker): Displays a range of values to be selected from. The Data Type property and the filter population query will determine the final appearance of this filter: a calendar if using or returning dates, or a number slider otherwise. Note: The control types that include "(basic)" apart from "Text Box (basic)" are deprecated.
Data Type	Specifies the data type that this control will support. The data type determines how the value from the filter is consumed as well as the style of the control used for this type of data (e.g., Date Picker for DateTime or Date). For Date Picker, the item is used to set the available dates, where first and last values define the range; if there are more than two values, only these will be available. String Integer Number DateTime Date Boolean
Data Mask	Specifies the data mask to be applied to the text of the items displayed by this control. This will also be used to properly parse incoming values from the user to match them up with available items when assigning filter values through custom means.
Render Mode	Specifies how this filter control is rendered on the page. Enabled: Control is visible and usable by the user. Disabled: Control is visible but disabled for the user. Hidden: Control is unavailable to the user but can be set via a client-side request. System: Control can only be used by backend system-level processes and is not available to the client-side request.
Control Position	Deprecated. Specifies the position of control on the screen: Top: The entire first row (horizontal arrangement). (Default) Left: First column of the second row (vertical arrangement) Center: Second column of the second row (vertical arrangement) Right: Third column of the second row (vertical arrangement) Bottom: The entire third row (horizontal arrangement).
Display with parent	Determines whether this filter control is displayed on its parent's grouping container (default). When this setting is disabled, the filter control is positioned by its control position and sort order in the outermost layer of filter controls.
Control Rows Displayed	Deprecated. The number of rows or items that should be shown for this control (only applies to certain control types). Default: 1 Values: Integer value.
Max. Allowed Selections	The maximum number of selections that can be made by the user for controls that allow multiple selections. Leave this field empty or set it to 0 for unlimited selections.
Sort Selections to Top	Deprecated. Determines whether the currently selected items will be automatically sorted to the top of the item list. Default: true Values: Boolean value (true or false).
Sort Control by Level	Deprecated. Determines whether this filter control is sorted on the dashboard page based on its level in the hierarchy tree. When enabled, this filter control is displayed on the page (in the filter control area) before another filter control, if it is closer to the top of the navigation tree hierarchy than the other filter control. When this setting is disabled or this filter is at the same level as another filter, the Sort Order and Name of the filter object are used to determine its sort order on the page.
Child Control Orientation	Deprecated. Specifies the display orientation of this controls immediate child filter controls on the screen Default: Inherit this setting from its parent control; if no parent control, set to "Vertical." (Default) Vertical: Arrange child controls vertically below this control. Horizontal: Arrange child controls horizontally to the right of this control.
Control Style	Deprecated. The CSS style that is applied to the interactive filter control (e.g., textbox, select box, list).

Control label style

Setting

Description

Control Label Alignment

Deprecated.

The alignment of the filtering control's label with respect to the filtering control:

Default: Inherit this setting from its parent control; if no parent control, set to "Left." (Default)
None: Do not display a label for this control.
Left: Display label to the left of the control.
Right: Display label to the right of the control.
Top: Display label above the control.
Bottom: Display label below the control.

Control Label Text

The text of the label displayed for the filtering control.
Default: empty (displays the filter object's name when empty).
Values: String value.

Control Label Style

Deprecated.

The CSS style to use for the control's label. This setting overrides the style defined by the Style Class for the label.

Control set style

These settings determine the style of the control set box that renders around this control and all its child filter controls.

Setting	Description
Control Set Display type	Deprecated. This setting controls when a filter control set box (the frame around the control and its child controls) is displayed: Only When Child Controls present: This only displays the frame set when this control has child controls. (Default) Always: This always displays the frame set. Never: This never displays the frame set.
Control Set Label text	Deprecated. The text of the label displayed for this filter's set of controls. Default: empty (no label displayed when empty). Values: String value.
Control Set Style	Deprecated. The CSS style applied to the control set (e.g., field set) that surrounds the filter control and its child filter control, when rendered. Default: empty (uses class defined for the "FIELDSET" element of the "PortalDashboardFilterTable" class when empty). Values: String value.
Control Set Label Style	Deprecated. The CSS style to use for the label (legend) of this filter's set of controls (field set). This style overrides the CSS Class for the label of the control set.

System item options

These settings define the "special" list items that are automatically created and processed by the system.

Setting	Description
Auto-select single item	When enabled, the first non-system item in the list will be selected by default when there is only a single non-system item in the list of rendered items. Enabling this setting will select the single item even when the Select Item is defined. However, when there are values defined for the Default Selected value property, that overrides this setting.
Default Selected value	This value specifies the item(s) that are selected by default when no other values have been selected. Default: empty (the first item in the list is selected when empty) Values: String value. Multiple item values can be specified using a semicolon as a delimiter. Single quote text qualifiers are optional with doubling the single quote to escape the single quote. Scoped variables are supported.
Select Item option text	The text for a non-value option that will be inserted as the first option in the list that will request the user to select an item from the list. Default: empty (the item is not displayed when empty) Values: String value. The actual value will not be displayed, but the presence of a non-empty string value in this property will make the user select from this filter list before the page will fully render.
All Items option text	The text for a special option item that will be inserted at the top of the list (under the Select Item option, if specified), and allows the user to specify that they would like to use all listed non-empty values as their filtering criteria or the All Items value, depending on the usage of the filter defined by its @@PROMPT expression. Default: empty (item not displayed, when empty) Values: String value.
All Items option value	The value for a special option item that will be inserted at the top of the list (under the Select Item option, if specified), which allows the user to specify that they would like to use all listed non-empty values as their filtering criteria, or the All Items value, depending on the usage of the Filter defined by its @@PROMPT expression. Default: empty (item not displayed, when empty) Values: String value. Typically use a "true" expression, such as 1=1. Important: Both the All Items option text and All Items option value properties must be defined for this option to be displayed.
No Items option text	The text for a non-value option that will be inserted as the only option when there are no items listed for this filter control. Default: empty (item not displayed, when empty) Values: String value.

Filtering options

Dashboard filters may be set up to cascade – meaning, they link to each other in a parent-child relationship in which the parent filter limits the items presented in the child filter. For example, selecting a school in the Schools filter (a parent filter) will limit items in the Grade filter (a child filter) to the grades taught at the selected school. The Filtering options define how the control will work during a cascading filter setup.

Setting	Description
Parent Filter	The parent Filter Control used to filter the items contained in this control. Since filter controls may have the same name, if they exist under different folders, you may notice that there are several filter control items with the same name, but they have a different number in front of them, this number is their Object ID, and this identifies a unique Filter Control. If there are filter controls with the same name listed, then you will need to find the Filter Control with the correct Object ID, by exploring the tree to find the matching Object ID for the correct parent filter control.
Select Parent option text	Defines the SQL connection that will be used to execute the select statement that will populate the items for this dashboard filter control.
Allow Global items	When enabled, items that do not have a parent value defined, null for a specific parent filter, will be treated as a global item and displayed for any selections of that parent filter. If there are values defined on this item for another parent filter, the item will be filtered on that parent's filter's selections. When this setting is disabled (default), all parent values, according to Matching methods, must match for an item to be displayed in this child filter. When this setting is enabled and Matching methods are applied, a null parent value is treated as a match for that parent.
Parent Matching Method	The matching method used when determining items for this control when filtered by a parent filter control (This setting overrides the Child matching method if set to "All"). Default: Inherit this setting from its parent control. If no parent control, set this to "All." All: Display only those items that match all of this control's parent filter controls' selected values (recursively). For example, say there are two parents, using a 3-level cascading filter setup for this dashboard filter control, this means that an item in this list will be displayed if it matches at least one value selected from both of the two parent controls. Any: Display only those items that match any of this control's parent filter controls' selected values (recursively). For example, say there are two parents, using a 3-level cascading filter setup for this dashboard filter control, this means that an item in this list will be displayed if it matches at least one value selected from either of the two parent controls.
Child Matching Method	The matching method used when determining items for a child control when filtered by this control. Default: Inherit this setting from its parent control. If no parent control, set this to "All." All: Display only those items in the child filter control that match all of this control's selected values. (See the example for the "All" option under Parent Matching Method.) Any: Display only those items in the child filter control that match any of this control's selected values or match any other selected values from the child control's parents (recursively). (See the example for the "Any" option under Parent Matching Method.)

List source options

List source options determine the items that this filter control will be populated with.

Setting	Description
Source Type	The type of source where the list of values will be retrieved from. The type of statement used to obtain the available values. Available types are: SQL Statement: Uses a SQL query to generate the list. When this option is selected, a Source Connection and Source Select Statement are required. Custom List: Uses a static, delimited list where items are separated by the field delimiter. User Entered: This option does not support a list of items; no remaining settings need to be defined in the List Source section. Used with the "Text Box (basic)" filter control type.
Source Connection	This setting appears when "SQL Statement" is the selected source type. It contains the Link ID of the connection object to be used to retrieve a list of values. The SQL connection is used to execute the select statement that will populate the items for this Dashboard Filter control.
Source Select Statement	This setting appears when "SQL Statement" is the selected source type. It holds the SQL query select statement that is executed to return the results set that is used to populate the items for this Dashboard Filter control using the specified source connection. The order of the selected columns required is name, value, parent value, parent parent value, etc.
Field Delimiter	This setting appears when "Custom List" is the selected source type. It holds the character that is used to separate each field in an item. Available options are Comma, Tab, Colon, Semicolon, Vertical Bar, Dash, Underscore, Back Slash, and Forward Slash.
Custom List	This setting appears when "Custom List" is the selected source type. It holds the custom, delimited listing to be used to define the list of items for this filter control. The items are separated by a new line and the fields are separated by the Field Delimiter. An empty field value (no characters between the field delimiters, except string qualifiers) is treated as a null value. A double quote string qualifier is also supported to allow the field value to contain the field delimiter. The order of the fields required is name, value, parent value, parent parent value, etc. A comma-delimited example would be: Is SPED,YesNot SPED,No