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.
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.
|
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.
|
Control Position | Deprecated. Specifies the position of control on the screen:
|
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). |
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. |
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
|
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:
|
Control Label Text | The text of the label displayed for the filtering control. |
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:
|
Control Set Label text | Deprecated. The text of the label displayed for this filter's set of controls. |
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. |
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. |
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. |
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. |
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. |
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. |
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").
|
Child Matching Method | The matching method used when determining items for a child control when filtered by this control.
|
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:
|
Source Connection | This setting appears when "SQL Statement" is the selected source type. |
Source Select Statement | This setting appears when "SQL Statement" is the selected source type. |
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: |