Difference between revisions of "Settings"

Revision as of 12:04, 9 April 2015

Settings list provides a list of all the settings that control the client environment, giving the user the possibility to display and configure these settings. The settings are ordered according to theme, the part of environment it's responsible for controlling. Within each theme the settings are sorted alphabetically. Mandatory settings are indicated with a * next to the name.

List of settings

There are two types of settings in UBIK client: Global Settings and User Specific Settings.

Global settings

The Global Settings include the following

Name	Purpose
AuthServerName	The name of the server to connect to for user authentication
AuthPortNumber	The port number to use when connecting to the authentication server (optional)
AuthProtocol	The protocol to use for authentication over the Internet (e.g.: HTTPS). Available since VersionAndroid
UBIKAuthContentService	The name of the UBIK authentication service
MemoryUsage	Whether UBIK^® should lazy load or eager load all the content. Available since Release 2.4.0

User specific settings

The User Specific Settings include the following

Name	Purpose
Protocol	The protocol to use for data communication over the Internet (e.g.: HTTPS)
PortNumber	The port number to use when connecting to the content server (optional)
PriorityThreshold	Any property with a priority number greater than this integer setting value is regarded as a high priority property and is highlighted when being displayed
UpdateExpirySeconds	The number of seconds one has to wait before the same update will be considered necessary. If an update of certain content has just ended successfully and is requested again within the amount of time configured in this setting, the client simply dismisses the new request. However, this setting does not affect Forced Updates in Manual Synchronization Mode.
SyncMode	The possible values are Automatic, Manual Commit and Offline. For more details, please refer to Sync Mode.
ShowSystemProperties	If set to true, all properties will be displayed; otherwise, only the ones that are marked as visible.

Additionally, there are special cases of User Specific Settings that are available/visible before users login, to open the possibility of configuring the web service URL before logging in. These include the following

Name	Purpose
UBIKContextName	The UBIK CONTEXT name
UBIKApplicationName	The UBIK APPLICATION name
UBIKContentService	The name of the UBIK content service
ServerName	The name of the server to connect to for fetching content

These settings have the following characteristics that differs them from other user specific settings

available and editable before and after the login.
carry the value "change if needed" initially before login, to indicate to the user that this setting doesn't need to be set if it already has a previously saved value.

Demo settings

Additionally, the demo application and its unique user specific settings are listed as follows

Name	Purpose
PrepareMode	This is set to true/false when users switch the client to offline/online mode in the start menu. However, editing this setting directly might not trigger the expected behavior
NumberPropertyEditor	Whether to use the normal keyboard or the UBIK Number Pickers for editing numeric properties
CurrentAltitude	The (mock) altitude in meters to use in Augmented Reality activities, for non-manual locations (e.g. GPS, since the altutide for this is too inaccurate)
AltitudeOffset	The offset in meters to add to the current altitude in Augmented Reality activities (used for configuration of the device height)
ContentDistanceFilterThreshold	The threshold in meters up to which billboards are displayed in Augmented Reality activities
PositioningMode	The different positioning modes of the Location Manager can be selected with this setting.

PreSet actions

Load PreSets

The Load PreSet button can be used to Load Presets onto the settings.

Save PreSets

The Save PreSet button that is only available after login, can be used to Save Settings as Presets.

@@ Line 18: / Line 18: @@
 | ''AuthPortNumber''|| The port number to use when connecting to the authentication server (optional)
 |-
-| ''AuthProtocol''|| The protocol to use for authentication over the Internet (e.g.: HTTPS). Available since [[Release 2.4.2]]
+| ''AuthProtocol''|| The protocol to use for authentication over the Internet (e.g.: HTTPS). Available since {{VersionAndroid|2.4.2}}
 |-
 | ''UBIKAuthContentService''|| The name of the UBIK authentication service