Appboard/2.4/builder/data collections - Revision history

imported>David.moore: /* Managing Data Collections */

2014-06-05T16:23:45Z

Managing Data Collections

← Older revision		Revision as of 16:23, 5 June 2014
Line 31:		Line 31:
	\|-		\|-
	\|''Polling Period''		\|''Polling Period''
	\|When a data collection is active, i.e. configured on a visible widget, the polling period determines how frequently the client requests for updates. By default the polling period is set to zero (Disabled). See the [[appboard/2.4/builder/caching_and_polling\|Caching and Polling]] page for more information.]]		\|When a data collection is active, i.e. configured on a visible widget, the polling period determines how frequently the client requests for updates. By default the polling period is set to zero (Disabled). See the [[appboard/2.4/builder/caching_and_polling\|Caching and Polling]] page for more information. Note that polling will be temporarily disabled while editing [[appboard/2.4/builder/widgets\|Widgets]] or [[appboard/2.4/builder/widgets/actions\|Widget Actions]] and while in the [[appboard/2.4/builder/system_administration\|System Administration]] page.
	\|-		\|-
	\|''Last Poll''		\|''Last Poll''

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

2014-02-03T15:17:32Z

← Older revision		Revision as of 15:17, 3 February 2014
Line 68:		Line 68:
	#* '''Data Source''' - Select the Data Source that will be used for the Data Collection.		#* '''Data Source''' - Select the Data Source that will be used for the Data Collection.
	#* '''Options''' - Check one or more of the following options:		#* '''Options''' - Check one or more of the following options:
	#*# '''Filter''' - Provides an interface for adding server-side filters to the Data Collection ~~(See [[appboard/2.4/builder/server-side_data_collection_filter\|Server-Side Filters]] and [[appboard/2.4/builder/compare_static_value_filter\|Simple Property Comparison]] for more information)~~.		#*# '''Filter''' - Provides an interface for adding server-side filters to the Data Collection.
	#*# '''Server Side Sort''' - Allows you to specify the default sort order in which the Data Collection is displayed using these options:		#*# '''Server Side Sort''' - Allows you to specify the default sort order in which the Data Collection is displayed using these options:
	## '''Server Side Sort''' - Select the field from the Data Source by which the Data Collection will be sorted. You can select multiple columns to use for sorting.		## '''Server Side Sort''' - Select the field from the Data Source by which the Data Collection will be sorted. You can select multiple columns to use for sorting.
Line 75:		Line 75:
	#*# '''[[appboard/2.4/builder/caching_and_polling\|Polling]]''' - Provides the option of setting a Polling Interval. This is the number of seconds to wait before the client will fetch the latest data from the server cache. For example, if this is set to 30, every 30 seconds AppBoard will refresh the Data Collection to have the latest data from the server. The minimum polling interval value is 5 seconds and the maximum value is 3600 seconds (one hour). '''Note:''' To maximize performance, Data Collections are only polled when one or more of the Widgets that uses that Data Collection is in the foreground display.		#*# '''[[appboard/2.4/builder/caching_and_polling\|Polling]]''' - Provides the option of setting a Polling Interval. This is the number of seconds to wait before the client will fetch the latest data from the server cache. For example, if this is set to 30, every 30 seconds AppBoard will refresh the Data Collection to have the latest data from the server. The minimum polling interval value is 5 seconds and the maximum value is 3600 seconds (one hour). '''Note:''' To maximize performance, Data Collections are only polled when one or more of the Widgets that uses that Data Collection is in the foreground display.
	#* Click the '''Next''' button.		#* Click the '''Next''' button.
	# On the '''Client Side Filter''' panel, add one or more '''Client Side Filter Rules''' ~~as needed (See [[appboard/2.4/builder/client-side_data_collection_filter\|Client-Side Filters]] for more information)~~.		# On the '''Client Side Filter''' panel, add one or more '''Client Side Filter Rules'''.
	# Click "Finish" to create the Data Collection.		# Click "Finish" to create the Data Collection.

imported>Jason.nicholls: /* Filtering Data Collections */

2014-02-03T15:13:50Z

Filtering Data Collections

← Older revision		Revision as of 15:13, 3 February 2014
Line 56:		Line 56:

	=== Filtering Data Collections ===		=== Filtering Data Collections ===
	~~For general information about the various options for filtering Data Collections in AppBoard, see [[appboard/2.4/builder/filtering_data_collections\|Filtering Data Collections]].~~

			For general information about filters and filtering data in AppBoard, see the [[appboard/2.4/builder/filtering\|Filtering Overview]] page.

	=== Adding a Data Collection ===		=== Adding a Data Collection ===

imported>Jason.nicholls at 06:48, 14 December 2013

2013-12-14T06:48:13Z

← Older revision		Revision as of 06:48, 14 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Data Collections}}		{{DISPLAYTITLE:Data Collections}}
			[[Category:AppBoard 2.4]]
	[[Image:HeaderFlow03.png]]		[[Image:HeaderFlow03.png]]

imported>Mike.berman at 21:00, 1 November 2013

2013-11-01T21:00:47Z

← Older revision		Revision as of 21:00, 1 November 2013
Line 64:		Line 64:
	# Click '''Add''' button at the bottom of the page to launch the '''Data Collections Wizard'''.		# Click '''Add''' button at the bottom of the page to launch the '''Data Collections Wizard'''.
	# On the '''Configure''' panel, enter the following:		# On the '''Configure''' panel, enter the following:
	#* '''Data Collection Name''' - Provide a unique name for the Data Collection.		#* '''Data Collection Name''' - Provide a unique name for the Data Collection. Only underscores, hyphens, periods, and alphanumeric characters are allowed (no spaces).
	#* '''Data Source''' - Select the Data Source that will be used for the Data Collection.		#* '''Data Source''' - Select the Data Source that will be used for the Data Collection.
	#* '''Options''' - Check one or more of the following options:		#* '''Options''' - Check one or more of the following options:

imported>Jason.nicholls at 10:35, 2 October 2013

2013-10-02T10:35:27Z

← Older revision		Revision as of 10:35, 2 October 2013
Line 53:		Line 53:
	\|}		\|}

	== Filtering Data Collections ==
			=== Filtering Data Collections ===
	For general information about the various options for filtering Data Collections in AppBoard, see [[appboard/2.4/builder/filtering_data_collections\|Filtering Data Collections]].		For general information about the various options for filtering Data Collections in AppBoard, see [[appboard/2.4/builder/filtering_data_collections\|Filtering Data Collections]].


	== Adding a Data Collection ==		=== Adding a Data Collection ===
	Use these instructions to create a new Data Collection:		Use these instructions to create a new Data Collection:

Line 77:		Line 78:


	== Editing a Data Collection ==		=== Editing a Data Collection ===

	Use these instructions to modify an existing Data Collection:		Use these instructions to modify an existing Data Collection:

Line 89:		Line 91:


	== ~~Removing~~ a Data Collection ==		=== Deleting a Data Collection ===
	Use these instructions to ~~remove~~ an existing Data Collection:
			Use these instructions to delete an existing Data Collection:

	# Click '''Data Collections''' in the left side tool palette.		# Click '''Data Collections''' in the left side tool palette.
Line 96:		Line 99:
	# Click the '''Delete''' button at the bottom of the page.		# Click the '''Delete''' button at the bottom of the page.
	# Click '''Yes''' to confirm the removal of the Data Collection.		# Click '''Yes''' to confirm the removal of the Data Collection.

			{{Warning\|It is possible to delete data collections that are currently configured on widgets and in actions. Ensure this is the desired action.}}

imported>Jason.nicholls at 10:31, 2 October 2013

2013-10-02T10:31:10Z

← Older revision		Revision as of 10:31, 2 October 2013
Line 6:		Line 6:
	The data for a data collection originates from a data source entity, and in the simplest case without any filtering or sorting etc... should represent the set of data as returned by the external data source.		The data for a data collection originates from a data source entity, and in the simplest case without any filtering or sorting etc... should represent the set of data as returned by the external data source.

	As an administrator configuring AppBoard you can ~~conceptually~~ think of data collections as step in the ~~chain~~ of getting data from an external data source to drive a widget. It~~'s the~~ data collections widgets are configured to use, and that ~~most~~ actions ~~affect through the use of server and client side filtering~~. It's important to understand that in practice the AppBoard server keeps track of data collections on a per session basis. So if one user clicks a widget that performs a server side filter on ~~the~~ data collection, that will happen for that user but not other clients.		As an administrator configuring AppBoard you can think of data collections as a step in the pipeline of getting data from an external data source to drive a widget. It is data collections that widgets are configured to use, and it's the data collections that get filtered by filtering actions. It's important to understand that in practice the AppBoard server keeps track of data collections on a per session basis. So if one user clicks a widget that performs a server side filter on a data collection, that will happen for that user but not other clients.


	== Managing Data Collections ==		== Managing Data Collections ==

imported>Jason.nicholls: /* Managing Data Collections */

2013-10-02T10:26:19Z

Managing Data Collections

← Older revision		Revision as of 10:26, 2 October 2013
Line 13:		Line 13:

	[[File:appboard-2.4-data-collections.png\|thumb\|center\|700px\|Data Collections administration page]]		[[File:appboard-2.4-data-collections.png\|thumb\|center\|700px\|Data Collections administration page]]


	{\|class='wikitable'		{\|class='wikitable'

imported>Jason.nicholls at 10:26, 2 October 2013

2013-10-02T10:26:03Z

← Older revision		Revision as of 10:26, 2 October 2013
Line 2:		Line 2:
	[[Image:HeaderFlow03.png]]		[[Image:HeaderFlow03.png]]

	Data Collections are ~~sets of tabular data that are maintained in memory~~ by AppBoard~~. The contents~~ of ~~the Data Collections can be manipulated through~~ filtering, ~~grouping~~, sorting and ~~pivoting features available in~~ the ~~Data Collections Wizard. Associations~~ can ~~also~~ be ~~established between collections~~ to ~~support the visualization of multiple data sets~~.		Data Collections are the datasets consumed by AppBoard widgets to produce visualizations and also subjected to manipulation in the form of configured (default) filtering, filtering actions, sorting, and limiting row counts. Additionally if it is desired to have widgets update automatically without the Viewer being reloaded then data collections can be configured to have a polling interval.

			The data for a data collection originates from a data source entity, and in the simplest case without any filtering or sorting etc... should represent the set of data as returned by the external data source.

			As an administrator configuring AppBoard you can conceptually think of data collections as step in the chain of getting data from an external data source to drive a widget. It's the data collections widgets are configured to use, and that most actions affect through the use of server and client side filtering. It's important to understand that in practice the AppBoard server keeps track of data collections on a per session basis. So if one user clicks a widget that performs a server side filter on the data collection, that will happen for that user but not other clients.

	== Managing Data Collections ==		== Managing Data Collections ==

imported>Jason.nicholls: /* Managing Data Collections */

2013-10-02T10:05:14Z

Managing Data Collections

← Older revision		Revision as of 10:05, 2 October 2013
Line 9:		Line 9:
	The main page for managing data collections in the Builder is by selecting the ''Data Collections'' builder mode. By default a summary view of all data collections is shown with the following fields as shown below:		The main page for managing data collections in the Builder is by selecting the ''Data Collections'' builder mode. By default a summary view of all data collections is shown with the following fields as shown below:

	[[File:appboard-2.4-data-collections.png\|thumb\|~~650px~~\|Data Collections administration page]]		[[File:appboard-2.4-data-collections.png\|thumb\|center\|700px\|Data Collections administration page]]

	{\|class='wikitable'		{\|class='wikitable'