Difference between revisions of "UBIK Client Basics"
(→Synchronization) |
|||
| Line 104: | Line 104: | ||
==== Child objects ==== | ==== Child objects ==== | ||
| + | |||
| + | ==== [[Task Objects (UBIK Android)|Task objects]] ==== | ||
==== Editors ==== | ==== Editors ==== | ||
Revision as of 08:59, 11 August 2014
Contents
Prerequisites
Options
There are two types of settings in UBIK client: Global Settings and User Specific 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) |
| UBIKAuthContentService | The name of the UBIK authentication service |
The User Specific Settings include the following
| Name | Purpose |
|---|---|
| UBIKContextName | The UBIK CONTEXT name |
| UBIKApplicationName | The UBIK APPLICATION name |
| UBIKContentService | The name of the UBIK content service |
| Protocol | The protocol to use for data communication over the Internet (e.g.: HTTPS) |
| ServerName | The name of the server to connect to for fetching content |
| 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, 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 |
| 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. |
Demo Login
Username: Demo
Password: 1234
Working with UBIK®
Login
Users need to login in order to access confidential data. This can be done in the Login Dialog.
Menu
| Menu | Menu item | Purpose |
|---|---|---|
| Activity wheel | - | Shows if the client is currently downloading content from the server |
| Sync mode | - | Opens the sync manager (in manual sync mode) |
| Home | Start menu | Opens the start screen |
| Home | Settings | Opens the settings dialog |
| Home | Information | Shows information about the software version and the device |
Info Activity
Shows static information about the app, like the version code and the minimum required web service version. Also allows to add a server certificate to the app.
Content Browser
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.
Context Menu
Root objects
Child objects
Task objects
Editors
Geo Editor
Editor used to set GEO locations for a specific content object. This is done by accessing the GEO property editor of the object.
Properties
Boolean Properties
The user can switch Boolean properties by either clicking the checkbox in the property list view (without visible editor), or by clicking the property row to open the corresponding editor.
Selective List Properties
The user can select a value from a list of possible values for this property, by clicking on the saved property value on the property list view. The corresponding editor is displayed with the drop-down list already expanded. Once the user selects a value from the list, the value is immediately saved and editor closed. It is also possible to cancel the editing or delete the value.
Teach In
The user can enter the location manually or, if available, can use the location provided by the positioning service. In case the positioning service doesn't deliver any location the user has only the possibility to enter the location manually.
Documents
Redlining
See the section redlining in the Documents article.
POI View
Brings up the Augmented Reality view and displays Points of Interest (POI's) related to the current location of the mobile device.
Allows the user to navigate to an object using the Augmented Reality Navigation feature. It is accessible via a UBIK® object's context menu in the Content Browser.
Map View
Opens the Map view and displays Points of Interest (POI's) related to the current location of the mobile device.
Online/Offline mode
Switches between online and offline mode.
ID Marker
Provides a fast and convenient way for users to find objects that are identifiable through optical codes, in this case ID Markers.
QR Code
Provides a fast and convenient way for users to find objects that are identifiable through optical codes, in this case QR Codes.
Markerless
Opens the Augmented Reality view supporting Markerless Scanning based on Image Detection.
ID Marker 3D
Opens the Augmented Reality view supporting ID Marker Scanning based on ID Markers.
Support Button
The Support Button starts the communication application Skype and is available in the Action Bar of the UBIK.Android.Demo application only. It will be used to call directly a Support Hotline.
Synchronization
The UBIK® client gets its data from the UBIK Content web service and is capable of synchronizing differences between this service and itself. All data can be worked with offline. Depending on the Sync Mode setting, the synchronization will behave differently - either taking care of everything automatically or giving the user full control over which changes are sent ("committed") to the server and which updates are fetched from it. In case of an error, an Android Notification is shown to gently notify the user what has happened and eventually give hints on how to solve the problem.
Push Service
The UBIK® push service is a mechanism used by the clients in order to receive updates from the server.
