=Android= 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 {{key press|*}} next to the name. == Available settings ==All users have at least access to all settings statet in [[#List of settings|List of settings]]. Additional settings, namely the [[#AR settings|AR settings]] or [[#Demo settings|Demo settings]] are only available if the regarding plugin is part of the application built. {{TipUWP/Version|Since version 2.5.0 the former system of global settings and user-specific settings has been replaced by user-specific settings only.}} === List of settings === The basic stock of settings includes: {| class="wikitable" | width = "75%"|-! 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). {{Version/AndroidSince|2.4.2}}|-| ''UBIKAuthContentService''|| The name of the UBIK authentication service|-| ''MemoryUsage''|| Whether {{UBIK}} should [[Memory Usage (Android)|lazy load]] or [[Memory Usage (Android)|eager load]] all the content. {{Version/AndroidSince|2.4.0}}|-| ''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 [[METACLASSSCOPE#Visibility|visible]].|-| ''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|-| ''ExpectSingleSearchResult''|| If checked, single search results will be displayed in the ContentBrowser immediately instead of being shown in the result list. Available since {{Version/Android|2.5.0}}|-|} === AR settings ===The AR plugin has additional settings: {| class="wikitable" | width = "75%"|-! Name!! Purpose|-| ''CompassOffsetDegrees'' || The offset in degrees to change the magnetic north and therefore the orientation of the device (global setting).|-| ''Pose Estimation Systems''|| The different pose estimation systems considered in the [[Location Manager]] can be activated or deactivated with this setting.|-| ''SpatialiteDbPath''|| The path to the sqlite database containing the routing graph. It will be looked for on the public internal storage (Google calls that the "Primary External Storage"), which is NOT the SD-card.|-| ''StandardMapZoomLevel''|| Specifies the zoom level, which should be applied when using the zoom features of the [[Map_View]].|-| ''DefaultMapZoomLocation''|| Specifies the position, which should be zoomed to when opening the [[Map_View]] after login.|-| ''ContentDistanceFilterThreshold''|| The threshold in meters up to which billboards are displayed in Augmented Reality activities; also influences the scaling of billboards depending on their distance. {{Version/AndroidSince|2.5.4}}|-| ''NFC Scan Result Type''|| Specifies the type of information, which should be extracted from scanned [[RFID tags]]. {{Version/AndroidSince|3.0.0}}|-|} === Demo settings === Additionally, the demo application and its unique user specific settings are listed as follows {| class="wikitable" | width = "75%"|-! Name!! Purpose|-| ''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|-| ''SupportIntentTarget''|| The actual Uri / Activity class / app package to be opened as an Android intent when the support action is triggered. {{Version/AndroidSince|2.5.2}}|-| ''SupportIntentType''|| The type of the target (URI/APP_PACKAGE/ACTIVITY_CLASS) to be opened as an Android intent when the support action is triggered. {{Version/AndroidSince|2.5.2}}|-|} == Characteristics of settings == Settings have the following characteristics and behavior within the application:* Available and editable before and after the login.* Changes done before login are applied to the next user who attempts to login.** This goes for applying presets as well.** After applying a preset, changes of settings are also applied.** The settings defined are not just used by the user as new settings configuration, but are merged with the settings the user already has, and are overriding them. * Changes after login are saved for the user currently logged in. After logout and new login, they are restored, merged with the settings changed before login if there are some and finally they get applied to the user.* If a completely new user attempts to login without defining settings before or loading a preset, the default values of the settings as defined for the respective app are used. == PreSet actions == === Load PreSets === The {{key press|Load PreSet}} button can be used to [[HowTo:Load Presets]] onto the settings. === Save PreSets === The {{key press|Save PreSet}} button that is only available after login, can be used to [[HowTo:Save Settings as Presets]]. = WinX =
There are several categories of settings, each providing a group of configurable options for (a) specific feature(s).
|-
|}
=Android=
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 {{key press|*}} next to the name.
== Available settings ==
All users have at least access to all settings statet in [[#List of settings|List of settings]]. Additional settings, namely the [[#AR settings|AR settings]] or [[#Demo settings|Demo settings]] are only available if the regarding plugin is part of the application built. {{Tip/Version|Since version 2.5.0 the former system of global settings and user-specific settings has been replaced by user-specific settings only.}}
=== List of settings ===
The basic stock of settings includes:
{| class="wikitable" | width = "75%"
|-
! 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). {{Version/AndroidSince|2.4.2}}
|-
| ''UBIKAuthContentService''|| The name of the UBIK authentication service
|-
| ''MemoryUsage''|| Whether {{UBIK}} should [[Memory Usage (Android)|lazy load]] or [[Memory Usage (Android)|eager load]] all the content. {{Version/AndroidSince|2.4.0}}
|-
| ''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 [[METACLASSSCOPE#Visibility|visible]].
|-
| ''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
|-
| ''ExpectSingleSearchResult''|| If checked, single search results will be displayed in the ContentBrowser immediately instead of being shown in the result list. Available since {{Version/Android|2.5.0}}
|-
|}
=== AR settings ===
The AR plugin has additional settings:
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''CompassOffsetDegrees'' || The offset in degrees to change the magnetic north and therefore the orientation of the device (global setting).
|-
| ''Pose Estimation Systems''|| The different pose estimation systems considered in the [[Location Manager]] can be activated or deactivated with this setting.
|-
| ''SpatialiteDbPath''|| The path to the sqlite database containing the routing graph. It will be looked for on the public internal storage (Google calls that the "Primary External Storage"), which is NOT the SD-card.
|-
| ''StandardMapZoomLevel''|| Specifies the zoom level, which should be applied when using the zoom features of the [[Map_View]].
|-
| ''DefaultMapZoomLocation''|| Specifies the position, which should be zoomed to when opening the [[Map_View]] after login.
|-
| ''ContentDistanceFilterThreshold''|| The threshold in meters up to which billboards are displayed in Augmented Reality activities; also influences the scaling of billboards depending on their distance. {{Version/AndroidSince|2.5.4}}
|-
| ''NFC Scan Result Type''|| Specifies the type of information, which should be extracted from scanned [[RFID tags]]. {{Version/AndroidSince|3.0.0}}
|-
|}
=== Demo settings ===
Additionally, the demo application and its unique user specific settings are listed as follows
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''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
|-
| ''SupportIntentTarget''|| The actual Uri / Activity class / app package to be opened as an Android intent when the support action is triggered. {{Version/AndroidSince|2.5.2}}
|-
| ''SupportIntentType''|| The type of the target (URI/APP_PACKAGE/ACTIVITY_CLASS) to be opened as an Android intent when the support action is triggered. {{Version/AndroidSince|2.5.2}}
|-
|}
== Characteristics of settings ==
Settings have the following characteristics and behavior within the application:
* Available and editable before and after the login.
* Changes done before login are applied to the next user who attempts to login.
** This goes for applying presets as well.
** After applying a preset, changes of settings are also applied.
** The settings defined are not just used by the user as new settings configuration, but are merged with the settings the user already has, and are overriding them.
* Changes after login are saved for the user currently logged in. After logout and new login, they are restored, merged with the settings changed before login if there are some and finally they get applied to the user.
* If a completely new user attempts to login without defining settings before or loading a preset, the default values of the settings as defined for the respective app are used.
== PreSet actions ==
=== Load PreSets ===
The {{key press|Load PreSet}} button can be used to [[HowTo:Load Presets]] onto the settings.
=== Save PreSets ===
The {{key press|Save PreSet}} button that is only available after login, can be used to [[HowTo:Save Settings as Presets]].
<headertabs/>
[[Category:Client|Settings]]