View source for UBIK Client Basics

{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.

Client applications are available for Android and WinX, however the features available on each of the platform dependent applications might differ. An overview of the available features can be found in the [[Client_Feature_Table|feature comparison table]].

== Start Screen ==
The start screen (or start menu) is the first visible view. It contains the login button and several actions, most of them accessible only after login. The start screen's content is [[HowTo:Configure Start Screen Content|configurable]]. For any specific app, the start screen usually also has a (overwritable) default configuration compiled into the app.

== Login ==
Users need to login in order to access confidential data, this can be done in the [[Login Dialog]].

There is the possibility to define user credentials on a webservice. The user might get a different login UI then, for further information please take a look at [[Serverside Account Configuration]]. {{Version/AndroidSince|2.5.0}}



== Settings ==
Users can configure access and edit the settings controlling {{UBIK}} environment using the [[Settings|settings list]].

== Action Bar ==
On the top of every {{UBIK}} Android view, there is the action bar. It provides features like the [[Mobile_Free_Text_Search|free text search]] and buttons for receiving/sending changes from/to the server. Depending on the customization, other items like a ''Support button'' or a ''QR Code Scan button'' can be available. In some views, there are different actions than in others; e.g. in the map view there are map-specific actions.

The action bar also allows access to the navigation drawer. It also shows an icon of the currently viewed object or the app's logo if the view is not object-related.


{| class="wikitable" | width = "100%"
|-
! Icon !! Action item !! Purpose
|-
| [[File:Action_update.png|46 px|center]] || ''Update''  || Updates the currently viewed object and its children or (if no object is viewed) the meta definitions and infrastructure objects from the server.
|-
| [[File:Action_commit.png|46 px|center]] || ''Commit''  || Sends eventual changes of the currently viewed object (and its children) to the server, or opens the commit manager if no context object is viewed. {{Version/AndroidSince|2.5.2}}
|-
| [[File:Action_search.png|46 px|center]] || ''Search''  || Opens an input field that can be used for finding objects by free text search. {{Version/AndroidSince|2.4.5}}
|-
| [[File:Action_support.png|46 px|center]] || ''Support'' (Demo only) || Opens the configured support app, e.g. the Visocon Xing app. {{Version/AndroidSince|2.5.1}}
|-
|}



== Navigation Drawer ==
[[File:UI_Android_Navigation_Drawer.png|180 px|thumb|border|alt=Navigation Drawer|Navigation Drawer]]
The navigation drawer provides a convenient and familiar way of navigating the app. {{Version/AndroidSince|2.4.0}} There are two ways of opening/closing the drawer.
* Pressing the app logo in the top-left corner;
* Swiping from/to the left edge of the screen

{| class="wikitable" | width = "100%"
|-
! Drawer item !! Purpose
|-
| Start menu || Opens the start screen
|-
| Settings || Opens the [[Settings|settings]]
|-
| Information || Shows information about the software version and the device
|-
| Scanning|| Contains child items for scanning various codes and markers. {{Version/AndroidSince|2.4.3}}
|-
| AR || Contains child items for opening the Map or POI view. {{Version/AndroidSince|2.5.3}}
|-
| Support || Starts the communication application (e.g. Skype or Visocon) and is available in the UBIK.Android.Demo application only. It is used to directly get in touch with a support agent. <br/>The respective target Uri is configurable. {{Version/AndroidSince|2.5.2}}
|-
| Sync mode || Switches {{UBIK}} between different [[Sync Mode|sync modes]]
|-
|}



== Info Screen ==

[[File:UBIK_Android_UI_Info_Activity_Certificate_List.png|400 px|thumb|border|alt=Certificate List|Certificate List]]

Shows static information about the app, like the version code and the minimum required web service version.
It also contains additional buttons:
* {{key press|Install Certificate}}: Allows to [[HowTo:Install_UBIK_Client_Certificate|add a server certificate]] to the app.
* {{key press|Clear Cache}}: Deletes all local data for the current user. {{Version/AndroidSince|2.5.0}}
* {{key press|Show Certificates}}: Shows a list of installed certificates, with alias/subject and expiry date. {{Version/AndroidSince|2.5.1}}



== Content Browser ==
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.

Initially, a list of objects ("root objects") is shown. Upon selecting an object, a new browser is opened for that object, showing details about it.
When an object is selected in the content browser, it is called the browser's context.
For such a contextual object, child objects, properties and child documents are shown. Also, there is a context menu providing actions related to the currently selected object.

As every {{UBIK}} Android activity, the content browser also contains an action bar on the very top. By default, it provides a search button and buttons for updating an object or sending changes to the server ("committing").

=== Context Menu ===
[[File:UBIK_Android_UI_Content_Browser_Context_actions.png|400px|border|thumb|alt=Context Menu|Context Menu]]
In the Content Browser a context sensitive menu is available where actions can be triggered that are relevant for the currently viewed object.
For example the creation of a child element or showing this object in another view.

{| class="wikitable" | width = "100%"
|-
! Icon !! style="width:150px" | Action item !! Purpose
|-
| [[File:Action_create_content.png|46px|center]] || ''Create Object'' || Opens a selection dialog for possible child MetaClasses, creating an object for the user's choice. The new object is opened in a view for editing.
|-
| [[File:Action_take_picture.png|46 px|center]] || ''Take Picture'' || Opens the camera activity and creates a new document object for the resulting picture. The new object is opened in a view for editing.
|-
| [[File:Action_ar_nav.png|46 px|center]] || ''AR Navigation'' || Opens the AR navigation activity in order to navigate to the current object using augmented reality.
|-
| [[File:Action_geo_group.png|46 px|center]] || ''Geo Actions'' || Opens a selection dialog for several geo-related actions.
* ''Edit Geo Data'':[[File:Action_edit_geo_data.png|46 px|right]]
: Opens an editor for the geo location of the current object. Allows to use the device's current location for teach-in.
* ''AR Navigation'':[[File:Action_ar_nav.png|46 px|right]]
: Opens the AR navigation activity in order to navigate to the current object using augmented reality. {{Tip/Version|Feature removed in 2.5.3}}
* ''Show in Map'':[[File:Action_show_in_map.png|46 px|right]]
: Opens the Map activity, showing the current object.
* ''Use Location'':[[File:Action_use_location.png|46 px|right]]
: Uses the current object's location for positioning; applies the position for the device's location management.
|-
| [[File:Action_download_branch.png|46 px|center]] || ''Download Branch'' || Downloads the current object and all children and switches to offline mode.
|-
| [[File:Action_object_deletion_group.png|46 px|center]] || ''Delete Actions''  <br/>{{Version/AndroidSince|2.5.0}} || Provides several actions for reverting or removing the current object:
* ''Discard Local Object'':[[File:Action_icon_discard.png|46 px|right]]
: Deletes the object locally.
* ''Delete Object on Server'':[[File:Action_icon_delete.png|46 px|right]]
: Marks the object for deletion on the server.
* ''Revert Changes'':[[File:Action_icon_revert.png|46 px|right]]
: Undoes all local changes for the current object, resetting it to the last known status from the server.
|-
| [[File:Action_object_teach_in_group_wiki.png|46 px|center]] || ''[[UBIK_Client_Basics#Teach-in_Actions|Teach-in Actions]]'' <br /> {{Version/AndroidSince|2.5.2}} || Provides several actions for teaching-in values of scannable properties:
* ''QR-Code teach-in'':[[File:Action_icon_teach_in_qr_wiki.png|46 px|right]]
: Sets the value of the QR-Code property by scanning a QR-Code.
* ''Barcode teach-in'':[[File:Action_icon_teach_in_barcode_wiki.png|46 px|right]]
: Sets the value of the Barcode property by scanning a Barcode.
* ''RFID teach-in'':[[File:Action_icon_teach_in_rfid_wiki.png|46 px|right]]
: Sets the value of the RFID property by scanning a RFID-Tag.
|-
|}


{{Hint|Some actions are united in groups, e.g. the ''Geo Actions'' or the ''Delete Actions''. Clicking on the respective icons opens a selection dialog for the detail actions. <br/>Depending on the current object, some actions might not be available. If a group consequently contains only one element, it is displayed directly instead of the group.}}



=== Objects ===

==== Root objects vs child objects ====

The first entry point in the ''Content Browser'' is the list of root objects.
Since no element is viewed initially, there is no ''Context Menu'' here.

If an object is opened in the ''Content Browser'', it serves as its current "context".
The list of its child objects is shown in the left tab of the content browser when viewing an object.

==== Task objects ====
[[Task Objects (UBIK Android)|Task objects]] are {{UBIK}} objects with properties the user has to fill in. They can be identified by the status check box that shows their status (open or finished).

==== Query objects ====
[[Query Objects (UBIK Android)|Query objects]] are used for finding objects on the server using criteria entered on the client.

==== Safety relevant objects ====
The [[Safety Instructions]] feature allows to make sure a user has to view special ''Safety Documents'' before an object can be opened in the ''Content Browser''. {{Version/AndroidSince|2.5.1}}

==== Commissioning objects ====
[[Commissioning Objects (UBIK Android)|Commissioning objects]] are task objects with extended functionality. They can be identified by the status ican which either shows a cross a check or a circle.

==== Locked objects ====
In some cases it might be useful to lock objects until the user varifies to be near to these objects. This can be done with the [[SYSCLS_UNLOCK_BY_SCAN]] classification {{Version/AndroidSince|2.5.2}}. Instances of MetaClasses implementing this classification can only be edited after the object gets unlocked. The unlocking can currently happen by scanning any type of code (QR-Code, Barcode, ID-Marker, RFID, OCR) which is related to the according object. After a certain period of time (default 15min) the object gets locked again.

Take care that objects classified by [[SYSCLS_UNLOCK_BY_SCAN]] also need the corresponding properties (e.g. QR-Code property) such that the user is allowed to unlock these objects. If an object is locked, it is not possible to edit its properties. Furthermore, context actions like redlining or editing of documents, geo teach-in and deletion of the object on the server is not possible. Basically the locking is the same for all types of objects, except for work packages – unlocking them also means unlocking all underlying items (Tasks, Commissioning checks) as well.



=== Properties ===
In the Content Browser, properties are shown in the properties tab. Their appearance depends on the data type of their value, whether they are modifiable and whether they are currently modified.
Also, modifiable properties can be edited using the property editors described below.

==== Live value properties ====

If a user wants to know an up-to-date measurement value, for instance whether it is save to enter a room or shut down a pump, this property provides him this information with very frequently updated [[Live Values| live values]].

==== Direct editing of 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 Actions ====
Properties of type QR-Code, Barcode or RFID can be taught-in using the corresponding teach-in action, which is located in the context sensitive action bar. {{Version/AndroidSince|2.5.2}} An object has to implement the [[SYSCLS_OBJECTWITHIDMARKER]] or [[SYSCLS_OBJECTWITHRFIDTAG]] classification and a respective editable property in order to use this feature. When clicking on a teach-in action the corresponding scanner appears and once the right marker/tag is scanned, the code directly appears as the new property value.



==== Editors ====
{{UBIK}} has built-in editors for different property types, including String, Integer, Double, Boolean, DateTime, Geo data and Selective list.
Clicking on the input field of a property (or task) will open the respective editor. 

===== Geo Editor & Teach In =====
[[File:UI_ContentBrowser_TeachIn2_Android.png|thumb|220px|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.

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 ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See the [[Documents_(UBIK_Android)|Documents]] article for further information on documents.

=== MRO ===
UBIK provides the logic for Maintenance, Repair and Operations (MRO) features. This means, a user can report the status of work to be accomplished. Therefore specific MRO configuartions provide essential objects like workpackages and tasks to report accomplished tasks, results and confirmed workpackages. See the [[MRO_Objects_(UBIK_WinX)|MRO]] article for further information on MRO.

[[Category:Client|UBIK Client Basics]]

=== Dynamic Content Tabs ===
{{Version/AndroidSince|2.5.0}}

The content browser's tabs (children, properties and documents) are only shown if necessary (and if they are not empty). For some types of objects (e.g. tasks) specific tabs are always shown though, especially if a tab is considered the main view for that object.

It is possible to configure this feature in order to behave more precisely as desired. By default, the children tab is shown if no other view should be shown explicitely and if the client has no information whether there are children or not. This means that for objects where (by customizing) the properties tab or the documents tab should be shown when entering the browser, the children view is only shown if it is not empty.

However, if nothing is configured, the children tab will be shown by default, because there could be children on the server and it would be annoying for the user to not see the children tab at all until something is loaded.

This is the other way round for the properties tab, because properties are always known as soon as the object itself is available on the client.

Also, the documents tab is not shown by default because the documents most often are not the primary view. If they are, the customizing should take this into account.<br/>

==== Customizing Possibilities ====
There are basically two ways to configure the dynamic tabs feature:
* One can configure the [[SYSCLS_CHILDINFOOWNER|Children Information Classification]] (former: Document Owner Classification): this will lead to a precise behaviour of the dynamic tabs, because the client has more detailed knowledge about the children of respectively classified objects.
* Another possibility is the configuration of the [[SYSCLS_SHOWPROPERTIES]] or [[SYSCLS_SHOWDOCUMENTS]] classifications: this will lead to the displaying of the properties/documents tab as initial view, even if it is empty.

[[Category:Client|UBIK Client Basics]]

== UI Configurations ==
See [[UI_Configuration_(Mobile_Client)]].

== AR Features ==

=== POI View ===
Brings up the [[POI View|Augmented Reality view]] and displays Points of Interest (POI's) related to the current location of the mobile device.

=== AR Navigation ===
Allows the user to navigate to an object using the [[AR Navigation|Augmented Reality Navigation]] feature.
It is accessible via a {{UBIK}} object's context menu in the Content Browser.

=== Markerless ===
Opens the [[POI View|Augmented Reality view]] supporting [[HowTo:Configure_Dynamic_AR_Content#Markerless_Activity|Markerless Scanning]] based on Image Detection. If the scanned Object is a Geo-Object, it´s location can be used through [[UBIK Client Basics#Object Proximity Positioning|Object Proximity Positioning]]

=== ID Marker 3D ===
Opens the [[POI View|Augmented Reality view]] supporting [[HowTo:Configure_Dynamic_AR_Content#ID_Marker_Activity|ID Marker Scanning]] based on ID Markers. If the scanned Object is a Geo-Object, it´s location can be used through [[UBIK Client Basics#Object Proximity Positioning|Object Proximity Positioning]]

=== Map View ===
Opens the [[map View|Map view]] and displays Points of Interest (POI's) related to the current location of the mobile device.

== Positioning ==
{{UBIK}} clients use a [[Location_Manager|Location Manager]] in order to gain knowledge about their position, so it can help the user navigate to his/her target.

The user can [[HowTo:Switch_Positioning_Mode_(UBIK_Android)|choose one of different positioning modes]] optimized for different environments.
Most of them incorporate multiple technologies for calculating positions or checking their reliability.

=== Positioning modes ===

* ''Outdoor mode'' - used for outdoor positioning
* ''Indoor mode'' - used for indoor positioning
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon mode'' - uses iBeacon triangulation only

=== Technologies ===

==== GPS ==== 
GPS is used as a primary positioning input source for outdoor areas. Its precision depends on the environment and satellite availability. With good circumstances, the accuracy varies between 1 and 10 meters.

==== LLA markers ==== 
LLA markers basically are QR codes with location data encoded into them - which can be used for positioning when they are scanned.

==== Dead Reckoning ==== 
Dead Reckoning uses a device's magnetic & acceleration sensor in order to estimate the movement the device undergoes. This way, the current location can be calculated based on an earlier known location and the movement that happend in between.

==== Edge plausibility ====
An "edge" in this context means the description of a path section inside an area, e.g. a corridor in a building.

Since positioning is not perfectly accurate, a location candidate has to be judged whether it can be relied on or not. This can be done using an edge model describing the ways the device can possibly take. If the alleged position is, let's say, inside a wall, then it is probably wrong. Such an edge model can also be used for optimizing a wrong position by snapping it onto the nearest edge.

==== Speed plausibility ====
Another way to judge a position's quality is to check how fast the device would have to move in order to get to it from its previous location. If the necessary speed is too fast, the position is deemed implausible. 

==== Object Proximity Positioning ====
The location of nearby Geo-Objects can be used for positioning.

The position of a Geo-Object can be used manually by pushing the button {{key press|Use Location}} in the [[UBIK Client Basics#Context Menu|Context Menu]]. 

The geo information of an object gets used automatically if exactly one single object is found through scanning. If more objects are found, their geo information doesn´t get used. Scanning includes [[UBIK Client Basics#ID Marker|ID Marker]], [[UBIK Client Basics#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]], [[UBIK Client Basics#RFID|RFID]], [[UBIK Client Basics#Markerless|Markerless]] and [[UBIK Client Basics#ID Marker 3D|ID Marker 3D]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== iBeacon-Trilateration Positioning ====
iBeacons are small, battery-powered devices, which are sending an unique identifier via Bluetooth Low Energy. iBeacons have to be mounted on known positions inside a building. If more than three beacons are in reach of the mobile device, the position of the user can be calculated.

In order to use iBeacon-Trilateration as a Positioning System, Bluetooth Low Energy has to be available and enabled on the mobile device.  
If a new environment should be equipped with iBeacon-Positioning, an expert has to mount iBeacons on known positions and calibrate the transmission behaviour of these beacons. Currently the positions of beacons have to be hardcoded into UBIK through the Development Team. In future this should happen through UBIK Studio.

== Finding Objects ==
=== Free Text Search ===
A [[Mobile_Free_Text_Search|free text search feature]] is available in the Action Bar. The search action item opens a text input field when clicked. Use it to find objects by their Meta Class name, their Display Strings or properties. The search feature works online and offline. {{Version/AndroidSince|2.4.5}}

=== ID Marker ===
Provides a fast and convenient way for users to find objects that are identifiable through [[optical code|optical codes]], in this case ID Markers. If the scanned Object is a Geo-Object, it´s location can be used through [[UBIK Client Basics#Object Proximity Positioning|Object Proximity Positioning]]

=== QR Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[optical code|optical codes]], in this case QR Codes. When using Getac Z710 the integrated barcode/qr-code scanner can get used. If the scanned Object is a Geo-Object, it´s location can be used through [[UBIK Client Basics#Object Proximity Positioning|Object Proximity Positioning]]

=== Bar Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[optical code|optical codes]], in this case Bar Codes. When using Getac Z710 the integrated barcode/qr-code scanner can get used. If the scanned Object is a Geo-Object, it´s location can be used through [[UBIK Client Basics#Object Proximity Positioning|Object Proximity Positioning]]

=== RFID ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]]. If the scanned Object is a Geo-Object, it´s location can be used through [[UBIK Client Basics#Object Proximity Positioning|Object Proximity Positioning]]

=== OCR ===
Provides a fast and convenient way for users to find objects that are identifiable through [[OCR|OCR]]. If the scanned Object is a Geo-Object, it´s location can be used through [[UBIK Client Basics#Object Proximity Positioning|Object Proximity Positioning]]. {{Version/AndroidSince|2.5.0}}


== 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.

=== Updating and Committing ===
Sending changed data from the mobile device to the {{UBIK}} server is called "committing". Fetching new data from the server is called "updating".<br/>
In {{UBIK}} Android's Action Bar, there are buttons for both actions. Their detail behaviour depends on the current view:
* In the Start Menu, the update button acquires basic data like the meta definitions or the infrastructure objects. The commit button opens the Commit Manager.
* In the Content Browser, the update button updates the currently viewed object and its children. Similarly, the commit button sends changes for the currently viewed object to the server. When committing an object in the Content Browser, all its changed child objects are also committed. {{Version/AndroidSince|2.5.2}}
* In the Commit Manager, one can select objects to commit or update from a list of all changed objects.

=== Synchronization Mode ===
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.<br/>
There are the following Sync Modes:
* Automatic: Handles updates and commits without requiring user input.
* Manual Commit: Updates automatically, lets the user decide when to commit changes.
* Offline: Doesn't update nor commit anything automatically; except for special situations like the first login in a new environment.

=== Error Handling ===
{{UBIK}} tries to solve problems automatically, for example by retrying failed web requests or updating missing content. 
In case of an error that couldn't be resolved automatically, an Android Notification is shown to gently notify the user what has happened and eventually give hints on how to solve the problem.

=== Push ===
The {{UBIK}} [[Push Service (Client)|push service]] is a mechanism used to notify a client of updates, show messages to the user or trigger other events on the client.

== See also ==
* [[Client_Feature_Table]]

[[Category:Client|UBIK Client Basics]]