Appboard/2.4/builder/filtering - Revision history

imported>Jason.nicholls: /* Data Filters */

2014-02-03T15:35:39Z

Data Filters

← Older revision		Revision as of 15:35, 3 February 2014
Line 19:		Line 19:
	=== Data Filters ===		=== Data Filters ===

	Both Server ~~Sider~~ Filters and Client Side Filters can be configured as part of a Data Collection configuration~~, and set using~~ widget actions. ~~Both~~ SSFs and CSFs can be used at the same time. If a data collection is configured with a SSF or CSF, and a widget action then sets a new SSF or CSF, this will ''replace'' the configured filter.		Both Server Side Filters and Client Side Filters can be configured:

			# As part of the Data Collection configuration.
			# By defining widget actions.

			SSFs and CSFs can be used at the same time. If a data collection is configured with a SSF or CSF, and a widget action then sets a new SSF or CSF, this will ''replace'' the configured filter.

	Why server-side vs client-side? By performing filtering on the server the total data sent to the client can be reduced. This is especially useful if only a fraction of the total data collection is ever to be seen at one time. SSFs are also required if using SHIM query parameters.		Why server-side vs client-side? By performing filtering on the server the total data sent to the client can be reduced. This is especially useful if only a fraction of the total data collection is ever to be seen at one time. SSFs are also required if using SHIM query parameters.

imported>Jason.nicholls at 15:28, 3 February 2014

2014-02-03T15:28:00Z

← Older revision		Revision as of 15:28, 3 February 2014
Line 7:		Line 7:
	** '''Server Side Filters''' (SSF): reduce the size of a data collection on the server side, i.e. client only receives reduced set of data. Server side filters are also used to drive SHIM query parameters.		** '''Server Side Filters''' (SSF): reduce the size of a data collection on the server side, i.e. client only receives reduced set of data. Server side filters are also used to drive SHIM query parameters.
	** '''Client Side Filters''' (CSF): performed on the client to reduce the size of a data collection. The full data collection is received by the client from the server.		** '''Client Side Filters''' (CSF): performed on the client to reduce the size of a data collection. The full data collection is received by the client from the server.
			** '''Search Text''': A widget option to allow end-users to filter using plain text.
	* Visualization Filters:		* Visualization Filters:
	** '''Icon''': determine icon to display based on filter conditions		** '''Icon''': determine icon to display based on filter conditions
Line 27:		Line 28:

	Data Collection configuration vs via action? Typically if a filter is configured as part of a data collection configuration then this represents the default set of data that should be visible. When SSFs or CSFs are set via widget action it's typically to further filter based in the context of something the end-user has clicked on. Whether this is to drill-down to another board, or simply updated widgets already on the screen.		Data Collection configuration vs via action? Typically if a filter is configured as part of a data collection configuration then this represents the default set of data that should be visible. When SSFs or CSFs are set via widget action it's typically to further filter based in the context of something the end-user has clicked on. Whether this is to drill-down to another board, or simply updated widgets already on the screen.

			Another form of data collection filtering is the ''Show Search Text Option'' available when configuring widgets. Enabling this option provides a search icon in the widget title bar and when this is toggled by the end-user allows them to enter plain text which is used to further filter the data collection driving that widget.

	For more information please refer to:		For more information please refer to:
Line 33:		Line 36:
	* [[appboard/2.4/builder/widgets/actions/apply_a_server_side_filter_to_a_data_collection\|Apply a Server Side Filter to a Data Collection]] Action		* [[appboard/2.4/builder/widgets/actions/apply_a_server_side_filter_to_a_data_collection\|Apply a Server Side Filter to a Data Collection]] Action
	* [[appboard/2.4/builder/widgets/actions/apply_a_filter_to_a_data_collection\|Apply a Filter to a Data Collection]] (Client Side Filter) Action		* [[appboard/2.4/builder/widgets/actions/apply_a_filter_to_a_data_collection\|Apply a Filter to a Data Collection]] (Client Side Filter) Action
			* [[appboard/2.4/builder/widgets/options/show_search_text\|Show Search Text Option]]

	=== Visualization Filters ===		=== Visualization Filters ===

imported>Jason.nicholls at 15:21, 3 February 2014

2014-02-03T15:21:33Z

← Older revision		Revision as of 15:21, 3 February 2014
Line 5:		Line 5:

	* Data Filters:		* Data Filters:
	** '''Server Side Filters''' (SSF): reduce the size of a data collection on the server side, i.e. client ~~received~~ only ~~the~~ reduced set of data. Server side filters are also used to drive SHIM query parameters.		** '''Server Side Filters''' (SSF): reduce the size of a data collection on the server side, i.e. client only receives reduced set of data. Server side filters are also used to drive SHIM query parameters.
	** '''Client Side Filters''' (CSF): performed on the client to reduce the size of a data collection. The full data collection is received by the client from the server.		** '''Client Side Filters''' (CSF): performed on the client to reduce the size of a data collection. The full data collection is received by the client from the server.
	* Visualization Filters:		* Visualization Filters:

imported>Jason.nicholls: /* Visualization Filters */

2014-02-03T10:08:09Z

Visualization Filters

← Older revision		Revision as of 10:08, 3 February 2014
Line 41:		Line 41:

	Note that depending on the widget capabilities that editing a filter may present some additional options such as a ''Label'' (for Quick Filters), or specifying the size of the visualization.		Note that depending on the widget capabilities that editing a filter may present some additional options such as a ''Label'' (for Quick Filters), or specifying the size of the visualization.

	{{Note\|There is a subtle difference when using filters to drive an icon, color, or shape versus using the same filter as a ''Quick Filter''. When using as an icon, color, or shape filter the first matching rule applies in the order the rules are defined. When used as a ''Quick Filter'' each rule is independently evaluated which means that if some row of data matches multiple rules then it will appear (be counted) in multiple quick filters.}}

	For more information please refer to:		For more information please refer to:
Line 50:		Line 48:
	* [[appboard/2.4/builder/colored_shape_filter\|Colored Shape Filters]]		* [[appboard/2.4/builder/colored_shape_filter\|Colored Shape Filters]]
	* [[appboard/2.4/builder/widgets/options/use_filter\|Quick Filters]]		* [[appboard/2.4/builder/widgets/options/use_filter\|Quick Filters]]

			{{Note\|There is a subtle difference when using filters to drive an icon, color, or shape versus using the same filter as a ''Quick Filter''. When using as an icon, color, or shape filter the first matching rule applies in the order the rules are defined. When used as a ''Quick Filter'' each rule is independently evaluated which means that if some row of data matches multiple rules then it will appear (be counted) in multiple quick filters.}}

	=== Widget Action Filters ===		=== Widget Action Filters ===

imported>Jason.nicholls at 10:06, 3 February 2014

2014-02-03T10:06:32Z

← Older revision		Revision as of 10:06, 3 February 2014
Line 9:		Line 9:
	* Visualization Filters:		* Visualization Filters:
	** '''Icon''': determine icon to display based on filter conditions		** '''Icon''': determine icon to display based on filter conditions
	** '''Status Shape''': determine status shape to display based on filter conditions
	** '''Color''': determine color to show based on filter conditions		** '''Color''': determine color to show based on filter conditions
	** '''Colored Shape''': combination color and status shape filter		** '''Colored Shape''': combination color and status shape filter

imported>Jason.nicholls: /* Visualization Filters */

2014-02-03T10:04:41Z

Visualization Filters

← Older revision		Revision as of 10:04, 3 February 2014
Line 40:		Line 40:

	From AppBoard 2.4.1 it's possible to share filters of the same type as long as the rules within the filter match against attributes of the selected data collection. This should save duplication of filters from widget to widget.		From AppBoard 2.4.1 it's possible to share filters of the same type as long as the rules within the filter match against attributes of the selected data collection. This should save duplication of filters from widget to widget.

			Note that depending on the widget capabilities that editing a filter may present some additional options such as a ''Label'' (for Quick Filters), or specifying the size of the visualization.

	{{Note\|There is a subtle difference when using filters to drive an icon, color, or shape versus using the same filter as a ''Quick Filter''. When using as an icon, color, or shape filter the first matching rule applies in the order the rules are defined. When used as a ''Quick Filter'' each rule is independently evaluated which means that if some row of data matches multiple rules then it will appear (be counted) in multiple quick filters.}}		{{Note\|There is a subtle difference when using filters to drive an icon, color, or shape versus using the same filter as a ''Quick Filter''. When using as an icon, color, or shape filter the first matching rule applies in the order the rules are defined. When used as a ''Quick Filter'' each rule is independently evaluated which means that if some row of data matches multiple rules then it will appear (be counted) in multiple quick filters.}}

			For more information please refer to:

			* [[appboard/2.4/builder/icon_filter\|Icon Filters]]
			* [[appboard/2.4/builder/color_filter\|Color Filters]]
			* [[appboard/2.4/builder/colored_shape_filter\|Colored Shape Filters]]
			* [[appboard/2.4/builder/widgets/options/use_filter\|Quick Filters]]

	=== Widget Action Filters ===		=== Widget Action Filters ===

imported>Jason.nicholls: /* Visualization Filters */

2014-02-03T10:00:21Z

Visualization Filters

← Older revision		Revision as of 10:00, 3 February 2014
Line 37:		Line 37:
	=== Visualization Filters ===		=== Visualization Filters ===

			Visualization filters are used in widget configuration, diagrams, and relationships. They are typically used to classify data in order to determine what icon to show, what shape to show, what color to show, what background color, etc...

			From AppBoard 2.4.1 it's possible to share filters of the same type as long as the rules within the filter match against attributes of the selected data collection. This should save duplication of filters from widget to widget.

			{{Note\|There is a subtle difference when using filters to drive an icon, color, or shape versus using the same filter as a ''Quick Filter''. When using as an icon, color, or shape filter the first matching rule applies in the order the rules are defined. When used as a ''Quick Filter'' each rule is independently evaluated which means that if some row of data matches multiple rules then it will appear (be counted) in multiple quick filters.}}

	=== Widget Action Filters ===		=== Widget Action Filters ===

imported>Jason.nicholls at 09:47, 3 February 2014

2014-02-03T09:47:55Z

← Older revision		Revision as of 09:47, 3 February 2014
Line 14:		Line 14:
	** Widget Options Filter or '''Quick Filter''': either an ''Icon'' or ''Colored Shape'' filter that adds a button bar to the bottom of a widget to allow for quick filtering by the end-user.		** Widget Options Filter or '''Quick Filter''': either an ''Icon'' or ''Colored Shape'' filter that adds a button bar to the bottom of a widget to allow for quick filtering by the end-user.
	* '''Action Filter''': determines whether an action should be triggered based on what was clicked by the end-user.		* '''Action Filter''': determines whether an action should be triggered based on what was clicked by the end-user.

			[[File:appboard-2.4-visual-filters.png\|frame\|Example visual filters: icon, colored shape, and colored shape quick filter]]

	=== Data Filters ===		=== Data Filters ===
Line 34:		Line 36:

	=== Visualization Filters ===		=== Visualization Filters ===

	~~[[File:appboard-2.4-visual-filters.png\|frame\|Example visual filters: icon, colored shape, and colored shape quick filter]]~~


Line 43:		Line 43:

	As example, take a visualization which presents regional locations, main offices, and data centers all on the same map. If the location type information is available within the data collection then this can be used to drive visualization filters to visually indicate the difference between locations, and an administrator can configure actions to fire based on the location type too. Such as each location type taking the end-user to a ''different'' drill-down board based on that type.		As example, take a visualization which presents regional locations, main offices, and data centers all on the same map. If the location type information is available within the data collection then this can be used to drive visualization filters to visually indicate the difference between locations, and an administrator can configure actions to fire based on the location type too. Such as each location type taking the end-user to a ''different'' drill-down board based on that type.

			For more information please refer to the [[appboard/2.4/builder/widgets/actions\|Widget Actions]] page.

	[[File:appboard-2.4-widget-action-filters.png\|frame\|Example actions using default ''any'' and a ''specific'' filter (click ''Filter'' button to configure)]]		[[File:appboard-2.4-widget-action-filters.png\|frame\|Example actions using default ''any'' and a ''specific'' filter (click ''Filter'' button to configure)]]

imported>Jason.nicholls at 09:46, 3 February 2014

2014-02-03T09:46:19Z

← Older revision		Revision as of 09:46, 3 February 2014
Line 14:		Line 14:
	** Widget Options Filter or '''Quick Filter''': either an ''Icon'' or ''Colored Shape'' filter that adds a button bar to the bottom of a widget to allow for quick filtering by the end-user.		** Widget Options Filter or '''Quick Filter''': either an ''Icon'' or ''Colored Shape'' filter that adds a button bar to the bottom of a widget to allow for quick filtering by the end-user.
	* '''Action Filter''': determines whether an action should be triggered based on what was clicked by the end-user.		* '''Action Filter''': determines whether an action should be triggered based on what was clicked by the end-user.

	~~[[File:appboard-2.4-visual-filters.png\|frame\|Example visual filters: icon, colored shape, and colored shape quick filter]]~~


	=== Data Filters ===		=== Data Filters ===
Line 37:		Line 34:

	=== Visualization Filters ===		=== Visualization Filters ===

			[[File:appboard-2.4-visual-filters.png\|frame\|Example visual filters: icon, colored shape, and colored shape quick filter]]


	=== Widget Action Filters ===		=== Widget Action Filters ===

imported>Jason.nicholls: /* Widget Action Filters */

2014-02-03T09:45:36Z

Widget Action Filters

← Older revision		Revision as of 09:45, 3 February 2014
Line 43:		Line 43:

	As example, take a visualization which presents regional locations, main offices, and data centers all on the same map. If the location type information is available within the data collection then this can be used to drive visualization filters to visually indicate the difference between locations, and an administrator can configure actions to fire based on the location type too. Such as each location type taking the end-user to a ''different'' drill-down board based on that type.		As example, take a visualization which presents regional locations, main offices, and data centers all on the same map. If the location type information is available within the data collection then this can be used to drive visualization filters to visually indicate the difference between locations, and an administrator can configure actions to fire based on the location type too. Such as each location type taking the end-user to a ''different'' drill-down board based on that type.

			[[File:appboard-2.4-widget-action-filters.png\|frame\|Example actions using default ''any'' and a ''specific'' filter (click ''Filter'' button to configure)]]