Appboard/2.5/builder/errors - Revision history

imported>Jason.nicholls: /* Communication Failure */

2014-10-28T09:44:07Z

Communication Failure

← Older revision		Revision as of 09:44, 28 October 2014
Line 61:		Line 61:
	If the client cannot communicate with the server at all this message is shown. This type of error may occur due to a networking issue, e.g. wireless down or cable unplugged, or it could be due to the AppBoard server going offline.		If the client cannot communicate with the server at all this message is shown. This type of error may occur due to a networking issue, e.g. wireless down or cable unplugged, or it could be due to the AppBoard server going offline.

	For both admin and non-admin users the error message indicates <tt>Send request to server failed ...</tt>. Administrators also see the Data Collection that triggered the request, ~~but~~ in this ~~type of error really~~ the issue is the server is not contactable.		For both admin and non-admin users the error message indicates <tt>Send request to server failed ...</tt>. Administrators also see the Data Collection that triggered the request, however in this situation the real issue is the server is not contactable.

imported>Jason.nicholls: /* Client Timeout */

2014-10-28T09:42:40Z

Client Timeout

← Older revision		Revision as of 09:42, 28 October 2014
Line 40:		Line 40:
	For administrator users the error message reads <tt>Request timed out</tt> and indicates the specific Data Collection being queried. In example the screenshot this is <tt>mysql.slow_query</tt>.		For administrator users the error message reads <tt>Request timed out</tt> and indicates the specific Data Collection being queried. In example the screenshot this is <tt>mysql.slow_query</tt>.

	The client ~~has a~~ timeout so that data polls aren't completely blocked by a slow request~~. This gives other requests a chance to get issued~~. The duration is configurable, see the ''Client Behaviour'' section above for more details.		The client timeout exists so that data polls aren't completely blocked by a slow request. The timeout duration is configurable, see the ''Client Behaviour'' section above for more details.

	Generally a deployment should be designed such that users aren't waiting on slow queries to drive ~~the dashboards~~. This error message can help to identify the slow queries so caching and polling values can be tweaked, or other optimizations done to improve the response.		Generally a deployment should be designed such that users aren't waiting on slow queries to drive widgets. This error message can help to identify the slow queries so caching and polling values can be tweaked, or other optimizations done to improve the response.

	=== Server-Side Error ===		=== Server-Side Error ===

imported>Jason.nicholls: /* Client Timeout */

2014-10-28T09:41:23Z

Client Timeout

← Older revision		Revision as of 09:41, 28 October 2014
Line 33:		Line 33:
	=== Client Timeout ===		=== Client Timeout ===

	[[File:appboard-2.5-error-client-timeout.png\|frame\|right\|Example ~~Builder~~ client timeout error message]]		[[File:appboard-2.5-error-client-timeout.png\|frame\|right\|Example administrator client timeout error message]]
	<tt>There has been a connection error</tt>		<tt>There has been a connection error</tt>

imported>Jason.nicholls: /* Client Timeout */

2014-10-28T09:40:57Z

Client Timeout

← Older revision		Revision as of 09:40, 28 October 2014
Line 36:		Line 36:
	<tt>There has been a connection error</tt>		<tt>There has been a connection error</tt>

	A client timeout occurs when the client was able to issue a request but the server cannot ~~deliver~~ the ~~response quick enough~~. Unless the server itself is completely overloaded this type of error is typically because the data source itself is taking a long time to respond.		A client timeout occurs when the client was able to issue a request but the server cannot complete the request in time. Unless the server itself is completely overloaded this type of error is typically because the data source itself is taking a long time to respond.

	For administrator users the error message reads <tt>Request timed out</tt> and indicates the specific Data Collection being queried. In example the screenshot this is <tt>mysql.slow_query</tt>.		For administrator users the error message reads <tt>Request timed out</tt> and indicates the specific Data Collection being queried. In example the screenshot this is <tt>mysql.slow_query</tt>.

imported>Jason.nicholls: /* Client Behaviour */

2014-10-28T09:38:54Z

Client Behaviour

← Older revision		Revision as of 09:38, 28 October 2014
Line 15:		Line 15:
	In the Viewer when [[appboard/2.5/admin/accessing_appboard#Kiosk_Mode\|Kiosk Mode]] is enabled all error messages are suppressed.		In the Viewer when [[appboard/2.5/admin/accessing_appboard#Kiosk_Mode\|Kiosk Mode]] is enabled all error messages are suppressed.

	~~By default in the Viewer when~~ logged in as a non-administrator error messages are also displayed, however less information is shown to avoid disclosing any ~~senstive~~ information. Optionally the system administrator can modify the client configuration file to suppress all error messages in the Viewer:		When logged in as a non-administrator to the Viewer error messages are also displayed, however less information is shown to avoid disclosing any sensitive information. Optionally the system administrator can modify the client configuration file to suppress all error messages in the Viewer:

	* Edit <tt>[INSTALL_HOME]/server/webapps/enportal/visualizer/assets/config.xml</tt>		* Edit <tt>[INSTALL_HOME]/server/webapps/enportal/visualizer/assets/config.xml</tt>

imported>Jason.nicholls: /* Client Behaviour */

2014-10-28T09:38:10Z

Client Behaviour

← Older revision		Revision as of 09:38, 28 October 2014
Line 15:		Line 15:
	In the Viewer when [[appboard/2.5/admin/accessing_appboard#Kiosk_Mode\|Kiosk Mode]] is enabled all error messages are suppressed.		In the Viewer when [[appboard/2.5/admin/accessing_appboard#Kiosk_Mode\|Kiosk Mode]] is enabled all error messages are suppressed.

	In the Viewer when logged in as a non-administrator ~~then~~ error messages are displayed, however ~~only limited~~ information is shown. Optionally the system administrator can modify the client configuration file to suppress all error messages in the Viewer:		By default in the Viewer when logged in as a non-administrator error messages are also displayed, however less information is shown to avoid disclosing any senstive information. Optionally the system administrator can modify the client configuration file to suppress all error messages in the Viewer:

	* Edit <tt>[INSTALL_HOME]/server/webapps/enportal/visualizer/assets/config.xml</tt>		* Edit <tt>[INSTALL_HOME]/server/webapps/enportal/visualizer/assets/config.xml</tt>

imported>Jason.nicholls at 09:36, 28 October 2014

2014-10-28T09:36:49Z

← Older revision		Revision as of 09:36, 28 October 2014
Line 5:		Line 5:
	AppBoard consists of both a client component, the Builder or Viewer, and a server component. Errors can occur in a variety of circumstances both on the client and the server, sometimes these are very straight forward, and other times it can be a challenge to follow what is happening with complex deployments and many things happening at once.		AppBoard consists of both a client component, the Builder or Viewer, and a server component. Errors can occur in a variety of circumstances both on the client and the server, sometimes these are very straight forward, and other times it can be a challenge to follow what is happening with complex deployments and many things happening at once.

	This document is not a comprehensive guide to every error message, instead the focus is on errors that occur during communications between the client and server when trying to fetch data. This could be due to previewing ~~data collections~~, viewing a board, and any active (visible) ~~data collections~~ set to poll.		This document is not a comprehensive guide to every error message, instead the focus is on errors that occur during communications between the client and server when trying to fetch data. This could be due to previewing Data Collections, viewing a board, and any active (visible) Data Collections set to poll.

	== Client Behaviour ==		== Client Behaviour ==

imported>Jason.nicholls: /* Overview */

2014-10-28T09:35:54Z

Overview

← Older revision		Revision as of 09:35, 28 October 2014
Line 5:		Line 5:
	AppBoard consists of both a client component, the Builder or Viewer, and a server component. Errors can occur in a variety of circumstances both on the client and the server, sometimes these are very straight forward, and other times it can be a challenge to follow what is happening with complex deployments and many things happening at once.		AppBoard consists of both a client component, the Builder or Viewer, and a server component. Errors can occur in a variety of circumstances both on the client and the server, sometimes these are very straight forward, and other times it can be a challenge to follow what is happening with complex deployments and many things happening at once.

	This document is not a comprehensive guide to every error message, instead the focus is on errors that occur during communications between the client and server when trying to fetch data. This ~~would~~ be due to previewing data collections, viewing a board, and ~~in the background due~~ to ~~data collection polling~~.		This document is not a comprehensive guide to every error message, instead the focus is on errors that occur during communications between the client and server when trying to fetch data. This could be due to previewing data collections, viewing a board, and any active (visible) data collections set to poll.

	== Client Behaviour ==		== Client Behaviour ==

imported>Jason.nicholls: /* Overview */

2014-10-28T09:34:51Z

Overview

← Older revision		Revision as of 09:34, 28 October 2014
Line 5:		Line 5:
	AppBoard consists of both a client component, the Builder or Viewer, and a server component. Errors can occur in a variety of circumstances both on the client and the server, sometimes these are very straight forward, and other times it can be a challenge to follow what is happening with complex deployments and many things happening at once.		AppBoard consists of both a client component, the Builder or Viewer, and a server component. Errors can occur in a variety of circumstances both on the client and the server, sometimes these are very straight forward, and other times it can be a challenge to follow what is happening with complex deployments and many things happening at once.

	This document is not a comprehensive guide to every error message ~~as many are straight forward and directly tied to some action performed within~~ the ~~Builder. Instead this document focuses~~ on errors that occur during communications between the client and server when trying to fetch data. This would be due to previewing data collections, viewing a board, and in the background due to data collection polling.		This document is not a comprehensive guide to every error message, instead the focus is on errors that occur during communications between the client and server when trying to fetch data. This would be due to previewing data collections, viewing a board, and in the background due to data collection polling.

	== Client Behaviour ==		== Client Behaviour ==

imported>Jason.nicholls: /* Client Behaviour */

2014-10-28T09:33:51Z

Client Behaviour

← Older revision		Revision as of 09:33, 28 October 2014
Line 9:		Line 9:
	== Client Behaviour ==		== Client Behaviour ==

	In the event of an error ~~condition~~ the client ~~should~~ continue ~~to work correctly~~. ~~Active~~ Data Collections set to poll will ~~get re-polled on the next interval. For~~ one-off ~~polls~~, such as Data Collection preview, ~~these~~ are ''not'' automatically retried.		In the event of a data or communications error the client will attempt to gracefully continue. This means active Data Collections set to poll will continue to poll, however one-off queries, such as Data Collection preview, are ''not'' automatically retried.

	Administrator users in the Builder will ~~always~~ see all error messages. Some suppression is used to avoid displaying an error message that's already visible, or popping up within 30 seconds of the previous occurrence.		Administrator users in the Builder will see all error messages. Some suppression is used to avoid displaying an error message that's already visible, or popping up within 30 seconds of the previous occurrence.

	In the Viewer when [[appboard/2.5/admin/accessing_appboard#Kiosk_Mode\|Kiosk Mode]] is enabled all error messages are suppressed.		In the Viewer when [[appboard/2.5/admin/accessing_appboard#Kiosk_Mode\|Kiosk Mode]] is enabled all error messages are suppressed.