Appboard/old/widgets/circular gauge - Revision history

imported>Jason.nicholls at 11:37, 17 July 2014

2014-07-17T11:37:49Z

← Older revision		Revision as of 11:37, 17 July 2014
Line 1:		Line 1:
			{{DISPLAYTITLE:Circular Gauge Widget}}
			[[Category:AppBoard old]]
	== Sample Data ==		== Sample Data ==
	Instructions for bringing sample chart data into AppBoard can be found here: [[Sample_Chart_Data\|Sample Chart Data]]		Instructions for bringing sample chart data into AppBoard can be found here: [[Sample_Chart_Data\|Sample Chart Data]]

imported>Jason.nicholls: moved Circular Gauge Widget to appboard/old/widgets/circular gauge

2014-07-17T11:37:11Z

moved Circular Gauge Widget to appboard/old/widgets/circular gauge

← Older revision	Revision as of 11:37, 17 July 2014
(No difference)

imported>Jason.nicholls: /* Adding a Circular Gauge Widget */

2014-07-17T07:05:39Z

Adding a Circular Gauge Widget

← Older revision		Revision as of 07:05, 17 July 2014
Line 10:		Line 10:
	# Click "Add Widget" in the tool palette on the left.		# Click "Add Widget" in the tool palette on the left.
	#* If "Add Widget" is disabled, see [[appboard/old/stacks#Adding_a_Stack\|Adding a Stack]].		#* If "Add Widget" is disabled, see [[appboard/old/stacks#Adding_a_Stack\|Adding a Stack]].
	#* For a general overview of adding a "Widget" see [[~~Widgets~~\|Add/Edit/Remove a Widget]].		#* For a general overview of adding a "Widget" see [[appboard/old/widgets\|Add/Edit/Remove a Widget]].
	# Perform the following steps to select the Gauge Widget from the Add Widget dialog.		# Perform the following steps to select the Gauge Widget from the Add Widget dialog.
	#* Select the "Gauge" tab		#* Select the "Gauge" tab

imported>Jason.nicholls: /* Adding a Circular Gauge Widget */

2014-07-17T04:38:59Z

Adding a Circular Gauge Widget

← Older revision		Revision as of 04:38, 17 July 2014
Line 9:		Line 9:

	# Click "Add Widget" in the tool palette on the left.		# Click "Add Widget" in the tool palette on the left.
	#* If "Add Widget" is disabled, see [[~~Stacks~~#Adding_a_Stack\|Adding a Stack]].		#* If "Add Widget" is disabled, see [[appboard/old/stacks#Adding_a_Stack\|Adding a Stack]].
	#* For a general overview of adding a "Widget" see [[Widgets\|Add/Edit/Remove a Widget]].		#* For a general overview of adding a "Widget" see [[Widgets\|Add/Edit/Remove a Widget]].
	# Perform the following steps to select the Gauge Widget from the Add Widget dialog.		# Perform the following steps to select the Gauge Widget from the Add Widget dialog.

imported>Jason.nicholls: /* Additional Configuration Steps */

2014-07-17T04:21:36Z

Additional Configuration Steps

← Older revision		Revision as of 04:21, 17 July 2014
Line 83:		Line 83:

	== Additional Configuration Steps ==		== Additional Configuration Steps ==
	* See the following page for detail on configuring Widget Options: [[~~Options~~\|Options]]		* See the following page for detail on configuring Widget Options: [[appboard/old/options\|Options]]
	* See the following page for detail on configuring Widget Actions: [[~~Actions~~\|Actions]]		* See the following page for detail on configuring Widget Actions: [[appboard/old/actions\|Actions]]

imported>Jason.nicholls: /* Select a Data Collection */

2014-07-17T03:59:51Z

Select a Data Collection

← Older revision		Revision as of 03:59, 17 July 2014
Line 22:		Line 22:
	* Click the "Data Collection" pulldown, then select from the list of available Data Collections.		* Click the "Data Collection" pulldown, then select from the list of available Data Collections.
	* If you are using the sample CSV data, select "Sample.Data.ChartData".		* If you are using the sample CSV data, select "Sample.Data.ChartData".
	* If there are no Data Collections available in the pulldown, then see [[Sample_Chart_Data\|Sample Chart Data]], or [[~~Data_Collections~~\|Add/Edit/Remove a Data Collection]].		* If there are no Data Collections available in the pulldown, then see [[Sample_Chart_Data\|Sample Chart Data]], or [[appboard/old/data_collections\|Add/Edit/Remove a Data Collection]].


	== Label Field==		== Label Field==

imported>Jason.nicholls: /* Adding a Circular Gauge Widget */

2013-08-27T15:35:01Z

Adding a Circular Gauge Widget

← Older revision		Revision as of 15:35, 27 August 2013
Line 6:		Line 6:


	[[File:~~circularGaugeExample~~.png\|thumb\|center\|500px\|Circular Gauge Sample]]		[[File:CircularGaugeExample.png\|thumb\|center\|500px\|Circular Gauge Sample]]

	# Click "Add Widget" in the tool palette on the left.		# Click "Add Widget" in the tool palette on the left.
Line 17:		Line 17:
	#* (Optional) Select the Board on which you would like to place the Widget. AppBoard assumes the current board by default.		#* (Optional) Select the Board on which you would like to place the Widget. AppBoard assumes the current board by default.
	# Click the "Add Widget" button in the bottom toolbar.		# Click the "Add Widget" button in the bottom toolbar.


	== Select a Data Collection ==		== Select a Data Collection ==

imported>Mike.berman at 07:13, 21 May 2013

2013-05-21T07:13:26Z

← Older revision		Revision as of 07:13, 21 May 2013
Line 33:		Line 33:

	== Second Label Field ==		== Second Label Field ==
	The Second Label Field is available in AppBoard versions 2.4 or higher.		The Second Label Field is available in AppBoard versions 2.3.17 or higher.

imported>Mike.berman: add note about Second Label Field version availability

2013-05-21T07:11:51Z

add note about Second Label Field version availability

← Older revision		Revision as of 07:11, 21 May 2013
Line 32:		Line 32:


	== Second Label Field==		== Second Label Field ==
			The Second Label Field is available in AppBoard versions 2.4 or higher.


	Select a field that contains the desired secondary label to be used for each item in the data set.		Select a field that contains the desired secondary label to be used for each item in the data set.
	* The "rows" of data from this field (column) will be used as the secondary label for each gauge. directly below the Label Field, beneath the gauge.		* The "rows" of data from this field (column) will be used as the secondary label for each gauge. directly below the Label Field, beneath the gauge.

imported>Mike.berman at 07:05, 21 May 2013

2013-05-21T07:05:27Z

← Older revision		Revision as of 07:05, 21 May 2013
Line 4:		Line 4:

	== Adding a Circular Gauge Widget ==		== Adding a Circular Gauge Widget ==


	[[File:circularGaugeExample.png\|thumb\|center\|500px\|Circular Gauge Sample]]		[[File:circularGaugeExample.png\|thumb\|center\|500px\|Circular Gauge Sample]]

	# Click "Add Widget" in the tool palette on the left.		# Click "Add Widget" in the tool palette on the left.
	#* If "Add Widget" is disabled, ~~refer to the "~~Adding a Stack~~" section~~.		#* If "Add Widget" is disabled, see [[Stacks#Adding_a_Stack\|Adding a Stack]].
	#* For a general overview of adding a "Widget" ~~refer to~~ [[Widgets\|Add/Edit/Remove a Widget]].		#* For a general overview of adding a "Widget" see [[Widgets\|Add/Edit/Remove a Widget]].
	# Perform the following steps to select the Gauge Widget from the Add Widget dialog.		# Perform the following steps to select the Gauge Widget from the Add Widget dialog.
	#* Select the "Gauge" tab		#* Select the "Gauge" tab
	#* Select "Circular Gauge"		#* Select "Circular Gauge"
	#* (Optional) Enter a name for the Widget, such as "Sample Gauge". AppBoard will default to "Untitled" if no name is provided.		#* (Optional) Enter a name for the Widget, such as "Sample Gauge". AppBoard will default to "Untitled" if no name is provided.
	#* (Optional) Select the Board you'd like the ~~Gauge~~ Widget ~~to appear on~~. AppBoard assumes the current board by default.		#* (Optional) Select the Board on which you would like to place the Widget. AppBoard assumes the current board by default.
	# Click the "Add Widget" button in the bottom toolbar.		# Click the "Add Widget" button in the bottom toolbar.


	== Select a Data Collection ==		== Select a Data Collection ==
	Select a '''Data Collection''' that contains the information ~~you'd like~~ to use for this widget.		Select a '''Data Collection''' that contains the information to use for this widget.
	* Click the "Data Collection" pulldown, then select from the list of available Data Collections.		* Click the "Data Collection" pulldown, then select from the list of available Data Collections.
	* If you~~'re~~ using the sample CSV data, select "Sample.Data.ChartData".		* If you are using the sample CSV data, select "Sample.Data.ChartData".
	* If there are no Data Collections available in the pulldown, then ~~click here for instructions on how to bring in some~~ [[Sample_Chart_Data\|Sample Chart Data]], or ~~refer to~~ [[Data_Collections\|Add/Edit/Remove a Data Collection]].		* If there are no Data Collections available in the pulldown, then see [[Sample_Chart_Data\|Sample Chart Data]], or [[Data_Collections\|Add/Edit/Remove a Data Collection]].


	== Label Field==		== Label Field==
	Select the desired label to be used for each item in the data set.		Select a field that contains the desired label to be used for each item in the data set.
	* The "rows" of data from this column will be used as the label for each gauge.		* The "rows" of data from this field (column) will be used as the label for each gauge.
	If you're using ''Sample.Data.ChartData'', select "~~Month~~" to be the Label Field.		If you are using ''Sample.Data.ChartData'', select "Month" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.


			== Second Label Field==
			Select a field that contains the desired secondary label to be used for each item in the data set.
			* The "rows" of data from this field (column) will be used as the secondary label for each gauge. directly below the Label Field, beneath the gauge.
			If you are using ''Sample.Data.ChartData'', select "Planning" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.


	== Value Field ==		== Value Field ==
	The "Value Field" is what determines the ~~rotation~~ of the needle in the Gauge component.		The "Value Field" is what determines the placement of the needle inside the Gauge component.

	If you're using ''Sample.Data.ChartData'', select "Software" as the Value Field.		If you're using ''Sample.Data.ChartData'', select "Software" as the Value Field.


	== Start Value ==		== Start Value ==
	This option will crop the range of values used to determine the rotation of the needle. This option is useful when dealing with values that ~~don't~~ have much variation.		This option will crop the range of values used to determine the rotation of the needle. This option is useful when dealing with values that do not have much variation. For Example, SLA calculations usually result in values clustered around 99%. If you start from zero, then the gauge will show nearly identical needles. With a "Start Value" set at .095, the needles will show more variation, providing a more useful comparison across the data set as a whole.

	For Example, SLA calculations usually result in values clustered around 99%. If you start from zero, then the gauge will show nearly identical needles. With a "Start Value" set at ~~95%~~, the needles will show more variation, providing a more useful comparison across the ~~dataset~~ as a whole.


	== Comparative Measure ==		== Comparative Measure ==
	Comparative Measure is an optional secondary needle that can be shown on each gauge. It can be useful for showing a high water mark, or deviations from an historical average.		Comparative Measure is an optional secondary (shorter) needle that can be shown on each gauge. It can be useful for showing a high water mark, or deviations from an historical average.
			* Select a field that contains the desired value to use in placing the needle to show the comparative measure.


	== Thresholds (Color) ==		== Thresholds (Color) ==
	Threshold values determine the ~~color~~ that the ~~bars will be~~.		Setting thresholds is an important element in configuring the Gauge Widget. Threshold values determine the colors displayed in the gauge, as well as the numeric labels that are displayed around the gauge.
	# '''Dynamic''': ~~Lets you~~ derive threshold values from ~~a column of~~ data in ~~your data collection~~. This is useful if the values being plotted are compared against different scales.		# '''Dynamic''': Select one or more fields in the <b>Value</b> column, and AppBoard will derive threshold values from the data that is currently displayed in the Widget. This is useful if the values being plotted are compared against different scales. AppBoard will find the highest value of all the selected <b>Value</b> fields, and then automatically determine the 10 breakpoints to display, based on interpolating between (a) the greater of the lowest data value or "Start Value", and (b) the highest data value. Examples can include:
	#* Projected vs. Actual: ~~shows~~ the variation in projections by region as well as the actual values for that region.		#* Projected vs. Actual: Shows the variation in projections by region as well as the actual values for that region.
	#* SLA: Shows variation between service level agreements per customer as well as the actual SLA values.		#* SLA: Shows variation between service level agreements per customer as well as the actual SLA values.
	# '''Static''': Lets you manually enter a static threshold value to use across the data set.		# '''Static''': Lets you manually enter a static threshold value(s) to use across the data set. AppBoard will find the highest value of all the entered "Static" <b>Value</b> fields, and then automatically determine the 10 breakpoints to display, based on interpolating between (a) the greater of the lowest data value or "Start Value", and (b) the highest data value. The coloration of the gauge will also be determined by comparing the <b>Value Field</b> against the "Static" <b>Value</b> fields.
	#* Tickets: If there are more ~~then~~ 50 active tickets for any given location, the ~~Value Bar~~ should turn red.		#* Tickets: If there are more than 50 active tickets for any given location, the gauge background should turn red. Create a single Threshold, entering "50" for the "Static" value and select the red color.
	#* Events: When total number of critical events for a system exceeds 10, ~~plot~~ the ~~Value bar as~~ red.		#* Events: When total number of critical events for a system exceeds 10, the gauge background should turn red (if "Tint Gauge with Threshold Color" option is selected).

	If you are using ''Sample.Data.ChartData'', then set Red to "Dynamic" "Hardware", and Green to "Dynamic" "Totals".		If you are using ''Sample.Data.ChartData'', then set Red to "Dynamic" "Hardware", and Green to "Dynamic" "Totals".
Line 59:		Line 67:
	== Gauge Options ==		== Gauge Options ==
	The gauge widget has several unique rendering options.		The gauge widget has several unique rendering options.
	* '''Show Scale''': This option shows numerical labels inside the gauge.		* '''Show Scale in Gauge''': This option shows numerical labels inside the gauge.
	* '''Show Thresholds''': This option ~~show~~ threshold colors on the outside edge of the gauge when enabled.		* '''Show Thresholds in Gauge''': This option shows threshold colors on the outside edge of the gauge when enabled.
	* '''Tint Gauge''': This option will tint the face of the gauge with the appropriate threshold color when enabled.		* '''Tint Gauge with Threshold Color''': This option will tint the face of the gauge with the appropriate threshold color when enabled.
	[[Image:Gauge_Options.png\|Gauge Options]]		[[Image:Gauge_Options.png\|Gauge Options]]
			* '''Comparitive Measure Field''': See section above.


	== Gauge Size ==		== Gauge Size ==
	The Gauge Size slider affects how large the gauges are, which ~~impacts~~ the number of gauges that can be displayed in a ~~view~~.		The Gauge Size slider affects how large the gauges are, which will impact the number of gauges that can be displayed in a particular Widget.

	[[Image:Gauge_Sizes.png\|Gauge Sizes]]		[[Image:Gauge_Sizes.png\|Gauge Sizes]]