Appboard/2.5/builder/errors: Difference between revisions
imported>Jason.nicholls No edit summary |
imported>Jason.nicholls No edit summary |
||
| Line 6: | Line 6: | ||
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 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. | ||
{{Note|The behaviour of the Viewer is configurable, see the ''Client Behaviour'' section below. Also administrators receive more information in these types of errors versus a non-administrator user.}} | |||
== Types of Data / Communication Errors == | == Types of Data / Communication Errors == | ||
There are three main types of data and communications errors that can occur. | |||
== Client Behaviour == | |||
Administrator users in the Builder will always see all error messages. Some suppression is used to avoid the same error message popping up twice, 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 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: | |||
* Edit <tt>[INSTALL_HOME]/server/webapps/enportal/visualizer/assets/config.xml</tt> | |||
* Find the attribute <tt>viewerHideErrors</tt> and set this to <tt>true</tt> | |||
* Reload the client - a server restart is ''not'' required. | |||
Revision as of 07:41, 28 October 2014
Overview
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.
Types of Data / Communication Errors
There are three main types of data and communications errors that can occur.
Client Behaviour
Administrator users in the Builder will always see all error messages. Some suppression is used to avoid the same error message popping up twice, or popping up within 30 seconds of the previous occurrence.
In the Viewer when 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:
- Edit [INSTALL_HOME]/server/webapps/enportal/visualizer/assets/config.xml
- Find the attribute viewerHideErrors and set this to true
- Reload the client - a server restart is not required.
