Jump to: navigation, search

Difference between revisions of "UBIK Client Basics"

(→‎Options)
(→‎Locked objects)
 
(217 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
== Prerequisites ==
+
{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.
−
=== Options ===
+
−
There are two types of settings in UBIK client: [[Global Settings]] and [[User Specific Settings]].
+
  
−
The [[Global Settings]] include the following
+
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]].
  
−
{| class="wikitable" | width = "75%"
+
== 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%"
 
|-
 
|-
−
! Name!! Purpose
+
! Icon !! Action item !! Purpose
 
|-
 
|-
−
| ''AuthServerName''|| The name of the server to connect to for user authentication
+
| [[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.
 
|-
 
|-
−
| ''AuthPortNumber''|| The port number to use when connecting to the authentication server (optional)
+
| [[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}}
 
|-
 
|-
−
| ''UBIKAuthContentService''|| The name of the UBIK authentication service
+
| [[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}}
 
|-
 
|-
−
| ''MemoryUsage''|| Whether {{UBIK}} should [[Memory Usage (Android)|lazy load]] or [[Memory Usage (Android)|eager load]] all the content.
+
| [[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}}
 
|-
 
|-
 
|}
 
|}
  
−
The [[User Specific Settings]] include the following
 
  
−
{| class="wikitable" | width = "75%"
+
 
 +
== 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%"
 
|-
 
|-
−
! Name!! Purpose
+
! Drawer item !! Purpose
 
|-
 
|-
−
| ''UBIKContextName''|| The UBIK [[CONTEXT]] name
+
| Start menu || Opens the start screen
 
|-
 
|-
−
| ''UBIKApplicationName''|| The UBIK [[APPLICATION]] name
+
| Settings || Opens the [[Settings|settings]]
 
|-
 
|-
−
| ''UBIKContentService''|| The name of the UBIK content service
+
| Information || Shows information about the software version and the device
 
|-
 
|-
−
| ''Protocol''|| The protocol to use for data communication over the Internet (e.g.: HTTPS)
+
| Scanning|| Contains child items for scanning various codes and markers. {{Version/AndroidSince|2.4.3}}
 
|-
 
|-
−
| ''ServerName''|| The name of the server to connect to for fetching content
+
| AR || Contains child items for opening the Map or POI view. {{Version/AndroidSince|2.5.3}}
 
|-
 
|-
−
| ''PortNumber''|| The port number to use when connecting to the content server (optional)
+
| 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}}
 
|-
 
|-
−
| ''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
+
| Sync mode || Switches {{UBIK}} between different [[Sync Mode|sync modes]]
−
|-
+
−
| ''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]].
+
 
|-
 
|-
 
|}
 
|}
  
  
−
Additionally, the demo application and its unique user specific settings are listed as follows
 
  
−
{| class="wikitable" | width = "75%"
+
== 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%"
 
|-
 
|-
−
! Name!! Purpose
+
! Icon !! style="width:150px" | Action item !! 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
+
| [[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.
 
|-
 
|-
−
| ''NumberPropertyEditor''|| Whether to use the normal keyboard or the [[UBIK Number Pickers]] for editing numeric properties
+
| [[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.
 
|-
 
|-
−
| ''CurrentAltitude''|| The (mock) altitude in meters to use in Augmented Reality activities
+
| [[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.
 
|-
 
|-
−
| ''ContentDistanceFilterThreshold''|| The threshold in meters up to which billboards are displayed in Augmented Reality activities
+
| [[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.
 
|-
 
|-
−
| ''PositioningMode''|| The different  positioning modes of the [[Location Manager]] can be selected with this setting.
+
| [[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.
 
|-
 
|-
 
|}
 
|}
  
−
=== Demo Login ===
 
−
Username: Demo<br />
 
−
Password: 1234
 
  
−
== Working with {{UBIK}} ==
+
{{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.}}
  
−
=== Login ===
 
−
Users need to login in order to access confidential data. This can be done in the [[Login Dialog]].
 
  
−
=== Menu ===
 
  
−
{| class="wikitable" | width = "50%"
+
=== Objects ===
−
|-
+
−
! 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 ===
+
==== Root objects vs child objects ====
−
Shows static information about the app, like the version code and the minimum required web service version.
+
−
Also allows to [[Add a Certificate (UBIK Android)|add a server certificate]] to the app.
+
  
−
=== Content Browser ===
+
The first entry point in the ''Content Browser'' is the list of root objects.
−
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.
+
Since no element is viewed initially, there is no ''Context Menu'' here.
  
−
==== Context Menu ====
+
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.
  
−
==== Root objects ====
+
==== 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).
  
−
==== Child objects ====
+
==== Query objects ====
 +
[[Query Objects (UBIK Android)|Query objects]] are used for finding objects on the server using criteria entered on the client.
  
−
==== [[Task Objects (UBIK Android)|Task objects]] ====
+
==== 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}}
  
−
==== Editors ====
+
==== Commissioning objects ====
−
===== Geo Editor =====
+
[[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.
−
Editor used to set GEO locations for a specific content object. This is done by accessing the GEO property editor of the object.
+
  
−
==== Properties ====
+
==== Locked objects ====
−
===== Boolean Properties =====
+
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]] {{Version/AndroidSince|2.5.2}} and [[SYSCLS_UNLOCK_GROUP_BY_SCAN]] {{Version/AndroidSince|3.1.0}} classifications. 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. In the case of Unlocking a group of objects, alternatively also more than one object can be unlocked at once by sharing a common unlock code.
 +
 
 +
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. In the case of unlocking a group of objects, only one of the objects needs to be scannable in order to onlock all of them. 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.
 +
 
 +
[[Category:Client|UBIK Client Basics]]
 +
 
 +
=== 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.
 
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 =====
+
==== 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.
 
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 =====
+
 
 +
==== 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.
 +
 
 +
==== Default and Initial Values ====
 +
Default values are used as long as a property has no value on its own. Initial values are used for new instances so they aren't completely empty after creation. Both can be configured on the server. See also: [http://wiki.augmensys.com/index.php?title=MetaProperty#Default_value MetaProperty Wiki Article]
 +
 
 +
==== 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.
 
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 ====
+
[[Category:Client|UBIK Client Basics]]
−
===== Redlining =====
+
 
−
See the section [[Documents_(UBIK_Android)#Redlining|redlining]] in the [[Documents_(UBIK_Android)|Documents]] article.
+
=== 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 ===
 
=== POI View ===
Line 132: Line 238:
 
Allows the user to navigate to an object using the [[AR Navigation|Augmented Reality Navigation]] feature.
 
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.
 
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 ===
 
=== Map View ===
 
Opens the [[map View|Map view]] and displays Points of Interest (POI's) related to the current location of the mobile device.
 
Opens the [[map View|Map view]] and displays Points of Interest (POI's) related to the current location of the mobile device.
  
−
=== Online/Offline mode ===
+
== Positioning ==
−
Switches between online and offline mode.
+
{{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.
 +
 
 +
[[Category:Client|UBIK Client Basics]]
 +
 
 +
== 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 ===
 
=== 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.
+
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 ===
 
=== 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.
+
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]]
  
−
=== Markerless ===
+
=== Bar Code ===
−
Opens the [[POI View|Augmented Reality view]] supporting [[Help:Configure_Dynamic_AR_Content#Markerless_Activity|Markerless Scanning]] based on Image Detection.
+
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]]
  
−
=== ID Marker 3D ===
+
=== RFID ===
−
Opens the [[POI View|Augmented Reality view]] supporting [[Help:Configure_Dynamic_AR_Content#ID_Marker_Activity|ID Marker Scanning]] based on ID Markers.
+
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]]
  
−
=== Support Button ===
+
=== OCR ===
−
[[File:Ubik android support button.png|220 px|thumb|border|alt=Support Button|Support Button]]
+
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}}
−
The '''Support Button''' starts the communication application [http://www.skype.com 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 ===
 
  
 +
== Synchronization ==
 
The {{UBIK}} client gets its data from the UBIK Content web service and is capable of synchronizing differences between this service and itself.
 
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.
 
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 ===
+
=== Updating and Committing ===
−
The {{UBIK}} [[Push Service (Client)|push service]] is a mechanism used by the clients in order to receive updates from the server.
+
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:UBIK Client]]
+
[[Category:Client|UBIK Client Basics]]

Latest revision as of 08:20, 17 January 2019

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


Settings

Users can configure access and edit the settings controlling UBIK® environment using the settings list.

Action Bar

On the top of every UBIK® Android view, there is the action bar. It provides features like the 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.


Icon Action item Purpose
Action update.png
 Update Updates the currently viewed object and its children or (if no object is viewed) the meta definitions and infrastructure objects from the server.
Action commit.png
 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.
Action search.png
 Search Opens an input field that can be used for finding objects by free text search.
Action support.png
 Support (Demo only) Opens the configured support app, e.g. the Visocon Xing app.


Navigation Drawer

Navigation Drawer
Navigation Drawer

The navigation drawer provides a convenient and familiar way of navigating the app. 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
Drawer item Purpose
Start menu Opens the start screen
Settings Opens the Settings
Information Shows information about the software version and the device
Scanning Contains child items for scanning various codes and markers.
AR Contains child items for opening the Map or POI view.
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.
The respective target Uri is configurable.
Sync mode Switches UBIK® between different sync modes


Info Screen

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:

  • Install Certificate: Allows to add a server certificate to the app.
  • Clear Cache: Deletes all local data for the current user.
  • Show Certificates: Shows a list of installed certificates, with alias/subject and expiry date.


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

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.

Icon Action item Purpose
Action create content.png
 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.
Action take picture.png
 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.
Action ar nav.png
 AR Navigation Opens the AR navigation activity in order to navigate to the current object using augmented reality.
Action geo group.png
 Geo Actions Opens a selection dialog for several geo-related actions.
  • Edit Geo Data:
    Action edit geo data.png
Opens an editor for the geo location of the current object. Allows to use the device's current location for teach-in.
  • AR Navigation:
    Action ar nav.png
Opens the AR navigation activity in order to navigate to the current object using augmented reality.
  • Show in Map:
    Action show in map.png
Opens the Map activity, showing the current object.
  • Use Location:
    Action use location.png
Uses the current object's location for positioning; applies the position for the device's location management.
Action download branch.png
 Download Branch Downloads the current object and all children and switches to offline mode.
Action object deletion group.png
 Delete Actions
Provides several actions for reverting or removing the current object:
  • Discard Local Object:
    Action icon discard.png
Deletes the object locally.
  • Delete Object on Server:
    Action icon delete.png
Marks the object for deletion on the server.
  • Revert Changes:
    Action icon revert.png
Undoes all local changes for the current object, resetting it to the last known status from the server.
Action object teach in group wiki.png
 Teach-in Actions
Provides several actions for teaching-in values of scannable properties:
  • QR-Code teach-in:
    Action icon teach in qr wiki.png
Sets the value of the QR-Code property by scanning a QR-Code.
  • Barcode teach-in:
    Action icon teach in barcode wiki.png
Sets the value of the Barcode property by scanning a Barcode.
  • RFID teach-in:
    Action icon teach in rfid wiki.png
Sets the value of the RFID property by scanning a RFID-Tag.


IC Hint square.pngSome 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.
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 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 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.

Commissioning objects

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 and SYSCLS UNLOCK GROUP BY SCAN classifications. 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. In the case of Unlocking a group of objects, alternatively also more than one object can be unlocked at once by sharing a common unlock code.

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. In the case of unlocking a group of objects, only one of the objects needs to be scannable in order to onlock all of them. 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.

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

Default and Initial Values

Default values are used as long as a property has no value on its own. Initial values are used for new instances so they aren't completely empty after creation. Both can be configured on the server. See also: MetaProperty Wiki Article

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
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 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 article for further information on MRO.

Dynamic Content Tabs

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.

Customizing Possibilities

There are basically two ways to configure the dynamic tabs feature:

  • One can configure the 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.

UI Configurations

See UI Configuration (Mobile Client).

AR Features

POI View

Brings up the 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 Augmented Reality Navigation feature. It is accessible via a UBIK® object's context menu in the Content Browser.

Markerless

Opens the Augmented Reality view supporting Markerless Scanning based on Image Detection. If the scanned Object is a Geo-Object, it´s location can be used through Object Proximity Positioning

ID Marker 3D

Opens the Augmented Reality view supporting ID Marker Scanning based on ID Markers. If the scanned Object is a Geo-Object, it´s location can be used through Object Proximity Positioning

Map View

Opens the 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 in order to gain knowledge about their position, so it can help the user navigate to his/her target.

Finding Objects

Free Text Search

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

ID Marker

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

QR Code

Provides a fast and convenient way for users to find objects that are identifiable through 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 Object Proximity Positioning

Bar Code

Provides a fast and convenient way for users to find objects that are identifiable through 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 Object Proximity Positioning

RFID

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

OCR

Provides a fast and convenient way for users to find objects that are identifiable through OCR. If the scanned Object is a Geo-Object, it´s location can be used through Object Proximity Positioning.


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".
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.
  • 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.
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 is a mechanism used to notify a client of updates, show messages to the user or trigger other events on the client.

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=UBIK_Client_Basics&oldid=21120"