UBIK Wiki / Augmensys - User contributions [en]

Version 5.2 (WinX)

2026-07-02T13:58:29Z

KGR: /* 5.2.?? on 2026-??-?? */

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

== Availability ==
{{key press|Store}}: Publicly available in Microsoft Store.

{{key press|Store Beta}} / {{key press|Store Preview}}: Publicly available in Microsoft Store as beta or preview versions to those whose account email is participating in our beta or preview test. To join, please send an email to testing@augmensys.com and provide an email address to add to the list as well as the information which test you want to join. Alternatively you can contact the Augmensys staff and submit your chosen email address.

Example: Please add my email account example@example.com to the '''Beta''' test group for the '''WinX''' client.

<br/>
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with ⚠️}}

= Release Notes =

== Release ==

=== 5.2.?? on 2026-??-?? ===
* Resolved an issue where page transitions can be annoying/distracting.
* UBIK LABs (Experimental) The update interval for live value updates (LiveValueUpdateIntervalMs) can be configured in profiles.
* Updated all client localization translations.
* Fixed an issue where Developer Mode failed to display certain property descriptions.

[[Category:Client|Version 5.2 (WinX)]]
[[Category:Version 5.2|Version 5.2 (WinX)]]
[[Category:WinX|Version 5.2 (WinX)]]

== Known issues ==
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true.
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.
* Free Text Annotations that where created in former sessions cannot be selected and therefore cannot be edited any more.
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].
* Known issues regarding the [[Documents_(Client)#Remember_Document_Settings|Remember Document Settings]] feature:
** Saving the Zoom value via touch gestures is not supported.
** Due to a third-party framework issue it can't be guaranteed that saving the Zoom level is always working properly. We reported this issue and will update our solution as soon as it is resolved on their side.
<br/>

= ⚠️ XAML Notes =

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Client|Version 5.2 (WinX)]]
[[Category:Version 5.2|Version 5.2 (WinX)]]
[[Category:WinX|Version 5.2 (WinX)]]

Version 5.2 (Mobile)

2026-07-01T09:50:06Z

KGR: /* 5.2.?? on 2026-??-?? */

{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.x. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}

{{Attention|UBIK 5 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}

{{Attention|The minimum supported OS versions are:
* Android 9;
* iOS 12.}}

== Availability ==
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.

{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.

{{key press|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].

{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/Kmb1HG9E invitation link].

{{key press|iOS: Store Preview}}: Available through Apple App Store's [https://testflight.apple.com/join/yHRnbYbt invitation link].

{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].
<br/>

{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}

= Release Notes =

== Release ==

=== 5.2.?? on 2026-??-?? ===
* UBIK LABs (Experimental) The update interval for live value updates (LiveValueUpdateIntervalMs) can be configured in profiles.
* Updated all client localization translations.

[[Category:Client|Version 5.2 (Mobile)]]
[[Category:Mobile|Version 5.2 (Mobile)]]
[[Category:Version 5.2|Version 5.2 (Mobile)]]

== Known issues ==
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true. In Mobile, deleting the last annotation does not correctly update the editor's internal edit state. As a result, the Save button may remain visible even though no edits exist.
* When changing the device orientation during attaching a photo on iOS, the app gets stuck. This is an issue Microsoft confirmed in .NET9 and will fix in .NET10.
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.
* Currently, the Samsung keyboard doesn't show {{key press|,}} at all, regardless of the current language/locale setting of the device. Please use a different virtual keyboard (e.g. Gboard from Google) instead if {{key press|.}} is unacceptable.
* The periodic execution of background pushes is not guaranteed on iOS (the native push feature doesn't have this issue).
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].
* It is currently not possible to select which camera to use for AR views (e.g. scan page) on Windows.
* SfPullToRefresh was removed due to [[Mobile_XAML#Issues_with_SfPullToRefresh_in_Mobile_client|existing issues]], and replaced with a Refresh option in the Context menu.

= ⚠️ XAML Notes =

<headertabs />

[[Category:Client|Version 5.2 (Mobile)]]
[[Category:Mobile|Version 5.2 (Mobile)]]
[[Category:Version 5.2|Version 5.2 (Mobile)]]

Version 5.2 (WinX)

2026-07-01T09:49:25Z

KGR: /* 5.2.?? on 2026-??-?? */

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

== Availability ==
{{key press|Store}}: Publicly available in Microsoft Store.

{{key press|Store Beta}} / {{key press|Store Preview}}: Publicly available in Microsoft Store as beta or preview versions to those whose account email is participating in our beta or preview test. To join, please send an email to testing@augmensys.com and provide an email address to add to the list as well as the information which test you want to join. Alternatively you can contact the Augmensys staff and submit your chosen email address.

Example: Please add my email account example@example.com to the '''Beta''' test group for the '''WinX''' client.

<br/>
{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with ⚠️}}

= Release Notes =

== Release ==

=== 5.2.?? on 2026-??-?? ===
* Resolved an issue where page transitions can be annoying/distracting.
* UBIK LABs (Experimental) The update interval for live value updates (LiveValueUpdateIntervalMs) can be configured in profiles.
* Updated all client localization translations.

[[Category:Client|Version 5.2 (WinX)]]
[[Category:Version 5.2|Version 5.2 (WinX)]]
[[Category:WinX|Version 5.2 (WinX)]]

== Known issues ==
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true.
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.
* Free Text Annotations that where created in former sessions cannot be selected and therefore cannot be edited any more.
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].
* Known issues regarding the [[Documents_(Client)#Remember_Document_Settings|Remember Document Settings]] feature:
** Saving the Zoom value via touch gestures is not supported.
** Due to a third-party framework issue it can't be guaranteed that saving the Zoom level is always working properly. We reported this issue and will update our solution as soon as it is resolved on their side.
<br/>

= ⚠️ XAML Notes =

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Client|Version 5.2 (WinX)]]
[[Category:Version 5.2|Version 5.2 (WinX)]]
[[Category:WinX|Version 5.2 (WinX)]]

Version 5.1 (Mobile)

2026-06-09T11:35:11Z

KGR: /* Release */

{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.1. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}

{{Attention|UBIK 5 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}

{{Attention|The minimum supported OS versions are:
* Android 9;
* iOS 12.}}

== Availability ==
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.

{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.

{{key press|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].

{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/Kmb1HG9E invitation link].

{{key press|iOS: Store Preview}}: Available through Apple App Store's [https://testflight.apple.com/join/yHRnbYbt invitation link].

{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].
<br/>

{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}

= Release Notes =

== Release ==
=== 5.1.?? 2026-??-?? {{key press|Android: Store}}{{key press|iOS: Store}} ===
* New features and enhancements in MRO.
** {{UBIK}} now supports defining [[MRO_Objects_(Client)#Procedure_Tasks|branching logic in procedure work packages]].
** {{UBIK}} now supports [[MRO_Objects_(Client)#Procedure_Tasks|calculation tasks which evaluate predefined expressions]].
** {{UBIK}} now supports [[MRO_Objects_%28Client%29#Pick_List_Task|MRO Pick List Tasks]] configured with an [[Active_List_Client|Active List]].
** Added [[MRO_Objects_(Client)#Numeric_Task|Numeric Tasks]] to record numeric values that are checked against an acceptable value range.
** Introduced a new [[MRO_Objects_(Client)#Picture_Task|picture task]] type which can only be finished when there's at least one valid child document.
** [[MRO_Objects_(Client)#Signature_Task|MRO Signature Tasks]] have been introduced, which automatically displays the signee as well as the validation timestamp after the task has been signed.
* UBIK now supports [[Traits]] which are more flexible when it comes to server side configuration and maintenance.
* The system flashlight can now also be enabled or disabled via XAML customization. For detailed information, see [[Mobile XAML#Flashlight|Flashlight]]
* Replaced app closing after repeated failed login attempts with a client-side temporary login block, including user feedback that indicates when login becomes available again.
* Added French localization to the app.
* Fixed an issue where changes in property editing were not discarded when using the default Back button.
* Fixed an issue where the application crashed on Windows when navigating back from the VideoPlayer.
* Icon set Addition 8: Added Show/Hide, AI, Info, and various Procedure icons.
* Fixed an issue where the [[Object_hierarchy_in_XAML:_NextLevel,_ParentLevel,_LinkedLevel#LoadNextLevelCommand|LoadNextLevelCommand]] did not work under specific conditions (invoked in offline and then in online mode).
* Fixed an issue where [[SYSCLS_CHILDINFOOWNER|child count]] indicators did not update when you delete its child objects which only exist locally.
* Fixed an issue where MRO task items displayed an incorrect DataTemplate after scrolling within a list.
* Fixed an issue where the client could fail at large file uploads (or even crash) due to device running out of memory.
* Fixed an issue where line breaks (in strings property values) from Windows are not recognized as such on other systems. The standard UI is not yet redesigned to show multi-line texts, though. But you can do so in customizing if necessary.
* Fixed the UI of some templates that weren't displayed correctly in Multi Select Mode.
* Fixed an issue where the status color was reflected as background color of an POI item.
* Fixed an issue where it was not possible to do a alternative import of a .profile file on iOS & Android.
* Fixed an issue where it was possible some list items were not updated correctly when e.g. you scroll through the list
* Fixed an issue where setting the SelectedIndex of a UBIKTabView leads to a crash.
* Fixed an issue where [[XAML_Tips#InvokeOnItemsCommand|BulkOperation.InvokeOnItemsCommand]] was not always applied to all items in the collection.
* Fixed an issue where the app sometimes redirects to the login page on certain Android devices. For example, when the device rotates or a physical keyboard is attached.
* Fixed an issue where the task value editing field is unlimited in space and covers everything else.
* Fixed an issue where filtering was not possible in query popups.
* Fixed an issue where it was not possible to set N/A via editors.

=== 5.1.30 2026-03-02 {{key press|Android: Store}}{{key press|iOS: Store}} ===
* Fixed an issue that prevented any documents from being uploaded when connecting to 5.1 webservices.

=== 5.1.29 on 2026-02-26 {{key press|Android: Store}}{{key press|iOS: Store}} ===
* Fixed an issue where the POI button was only visible under certain condition (ShowUnreleasedFeatures in the profile is set to true).

=== 5.1.28 on 2026-02-10 {{key press|Android: Store}}{{key press|iOS: Store}} ===
* The following features which existed in pre 5.0 versions are now available again in 5.1.
** [[Map_View|Map view]].
** [[POI_View_(Mobile)|POI view]]. (Aruco and OCR are not yet supported)
** Location service.
** [[Native_Push_(Client)|Native push]].
** [[Charts]].
* UBIK now uses industry-standard JSON Web Token (JWT) technology for authorization, enhancing security and reliability. Session tokens are transmitted via HTTP headers instead of URLs for improved protection.
* Added support for conditionally showing the ImageEditor Save button only when edits have been made, enabled when MergeAnnotationsOnSave is set to true.
* Complete UI overhaul introduces a cleaner, more modern and adaptive user interface with various quality of life improvements.
* UBIKTabView supports both dynamic and static items in combination with lazy loading.
* Files in the app's data folder can now be opened or deleted directly in the developer settings.
* Introduced a fully resource-driven UI theming system enabling fast, safe customization (dark mode, resizing, and consistent styling) by adapting a small set of centralized resources.
* Added support for [[File_Upload_Size_Restriction|configurable file-upload size restrictions]], preventing oversized files from being uploaded and providing users with feedback when limits are exceeded.
* Fixed an issue where annotated image documents do not appear as changed until the UI refreshes.
* Fixed an issue where displayed file content does not update after you revert its changes.
* Fixed an issue where remembered scroll positions were lost when the ItemsSource property of an SfListViewExt changed (e.g., Properties.ShowAllProperties).
* The UI now updates correctly after mass deletion in multi-selection mode.
* Fixed issue that caused app to be stuck on splash screen after resuming from background.
* Fixed an issue where StatusColor was not shown in the UI for objects that didn't additionally have a Progress.
* Fixed an issue where the Chart Thresholds didn't update.
* Fixed an issue that caused content of the custom ContentControl to not be rendered sometimes.
* (Android) Fixed an issue in the WebView where some links could not be opened.
* Fixed an issue where toggling NA in the String Editor did not behave correctly.
* Fixed an issue where the deletion of some objects was not reflected in the UI until refresh.
* Fixed an issue where document creation might not be properly enabled in certain customizing scenarios. For example, a media creation button might be disabled until a page refresh.
* Fixed an issue where batch creating documents (by multi selecting files to attach) can be interrupted if you leave the page.

[[Category:Client|Version 5.1 (Mobile)]]
[[Category:Mobile|Version 5.1 (Mobile)]]
[[Category:Version 5.1|Version 5.1 (Mobile)]]

== Known issues ==
* Due to third-party limitations, the feature that shows the ImageEditor Save button only when edits have been made is only active when MergeAnnotationsOnSave is set to true. In Mobile, deleting the last annotation does not correctly update the editor's internal edit state. As a result, the Save button may remain visible even though no edits exist.
* When changing the device orientation during attaching a photo on iOS, the app gets stuck. This is an issue Microsoft confirmed in .NET9 and will fix in .NET10.
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.
* Currently, the Samsung keyboard doesn't show {{key press|,}} at all, regardless of the current language/locale setting of the device. Please use a different virtual keyboard (e.g. Gboard from Google) instead if {{key press|.}} is unacceptable.
* The periodic execution of background pushes is not guaranteed on iOS (the native push feature doesn't have this issue).
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].
* It is currently not possible to select which camera to use for AR views (e.g. scan page) on Windows.
* SfPullToRefresh was removed due to [[Mobile_XAML#Issues_with_SfPullToRefresh_in_Mobile_client|existing issues]], and replaced with a Refresh option in the Context menu.

= ⚠️ XAML Notes =
* Due to the change of the underlying XAML technology, the existing XAMLs for the old mobile clients (pre 5.0) are no longer compatible. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.
* There are some XAML changes necessary when using the new [[Active_List_Client|Active List]] feature, or when using the new [[MRO_Objects_%28Client%29#Pick_List_Task|MRO Pick List Task]]. These XAML changes are explained [[Active_List_Client#XAML|here]].

<headertabs />

[[Category:Client|Version 5.1 (Mobile)]]
[[Category:Mobile|Version 5.1 (Mobile)]]
[[Category:Version 5.1|Version 5.1 (Mobile)]]

MRO Objects (Client)

2026-05-11T13:00:05Z

KGR: /* Organisational Status */

[[File:MRO_WinX.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:MRO_MAUI1.jpeg|thumb|alt=MRO Child List UI (Android)|MRO UI (Android)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===

The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

[[File:TechStats_WinX.png|100px|Technical Status Indicator (Winx & Mobile)]]

=== Organisational Status ===
The organisational status indicates the amount of confirmed work within the data branch, including already confirmed work packages as well as tasks that are locked by their owning work package. The organisational status indicator is displayed on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch, and visualizes the amount of confirmed work performed within that branch.
<gallery>
File:OrgaStatusIndicatorWinX.PNG|Organisational Status Indicator (WinX)
File:ConfirmedWP_WinX.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
File:ConfirmedWP_MAUI.jpeg|MRO Workpackage Confirmed Indicator (Mobile)
</gallery>

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

=== Work Progress ===
The work progress is calculated from the current work progress and from the progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Version/WinXSince|5.0}} {{Version/MobileSince|5.0}} By default, the progress is displayed with maximum one decimal place. For example, 99.75% is displayed as 99.8%. The format string used to achieve this is <code>{0:0.#}%</code>.

If other numeric formats are preferred in your usecases, you can refer to [https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings custom numeric format strings] for more information. The template to customize for this is the UBIKMROProgressBadge within UBIKThemes.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:ConfirmingWP_WinX.png|MRO Workpackage confirm button (WinX)
File:MRORevoke_WinX.png|MRO Workpackage revoke confirmation button (WinX)
File:ConfirmingWP_MAUI.jpeg|MRO Workpackage confirm button (Android)
File:MRORevoke_MAUI.jpeg|MRO Workpackage revoke confirmation button (Android)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

On both clients, a Task can be reverted by clicking twice on the Not Applicable button.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====

A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

<gallery widths=497px heights=69px>
File:Measurment Task Empty UWP.png|Measurement Task without a reported value (WinX)
File:Measurment Task Not Empty UWP.png|Measurement Task with a reported value (WinX)
File:Measurment Task Empty Android.jpg|Measurement Task without a reported value (Android)
</gallery>

==== Progress Task ====

[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

<gallery widths=497px heights=69px>
File:Progress Task UWP.png|Progress Task with a reported work progress (WinX)
File:Progress Task Android.jpg|Progress Task with a reported work progress and a previous progress(Android)
</gallery>

==== Check Task ====

A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

<gallery widths=497px heights=69px>
File:Check Task finished UWP.png|Unfinished MRO CheckTask (WinX)
File:Check Task android.jpg|Not Applicable MRO CheckTask (Android)
</gallery>

==== Inspection Task ====

[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

<gallery widths=497px heights=69px>
File:Finished Inspection Task UWP.png|Finished MRO InspectionTask (WinX)
File:Inspection task android.jpg|Finished MRO InspectionTask (Android)
</gallery>

==== Sequential Task ====
The [[MROCLS_SEQUENTIALTASK|sequential task classification]] allows you to pre-define a sequence in which tasks are to be resolved by users. This means that it is required for one or multiple tasks to be finished in order for other tasks to become "unlocked" and editable. A task can have any number of "predecessors". Predecessors are the tasks that are required to be finished first.

A task can have predecessors that live anywhere else in the object hierarchy. It is not necessary for a task and its predecessors to be part of the same work package, even though this is likely the most common use case.

The state of a sequential task is evaluated both offline and online to get the best possible user experience. The user will see dependent tasks update immediately if their successors were finished, if those tasks are currently visible in the UI. There is 1 case in which the server-side state will override the client-side (offline) evaluation, discussed below.
The state of each sequential task is evaluated the following way:

# If the server-side state says the task is open, we consider this as the truthful state and don't do any other evaluation.
# Check if the task has any predecessors.
# Try to load each predecessor task.
#* If loading of any predecessor fails (the object is not available offline), the task will be locked.
# If all predecessor tasks are finished, the task is open and can be edited. Otherwise, the task is locked.

The customizer setting up the task dependency relations needs to ensure that the dependencies are not cyclical. In this case, it would be impossible for any tasks in the "cycle" to be finished.

'''Example'''

As a demonstration of this feature, see [[Media:Sequential_tasks_winx.mp4|this video]]. The relations between tasks are defined as in [[Media:Task_relations.png|this image]], starting at A1 and A2, which are not dependent on any other tasks. The lines (from left to right) indicate dependencies. This means that B2 has tasks A1 and A2 as its predecessors, for example.

==== Grouped Task {{Version/WinXSince|4.2}}{{Version/XamarinSince|4.2}} ====
Sometimes, not all tasks have to be finished. More specifically, there might be a predefined condition where you only need to finish a certain number of tasks among a group of them. These are known in {{UBIK}} as [[MROCLS_GROUPEDTASK|grouped tasks]].

The idea is, a group of tasks can be defined as siblings to each other and they also share the same server configured threshold. When the number of finished tasks among that group exceeds the threshold, the entire group is considered as no longer necessary. When reflected in the overall status of the task owner(s), these tasks would appear as if they are finished.

{{Hint|Technically speaking, the finished status is completely independent from the not necessary status on a task. A grouped task which is no longer necessary can be both finished or not yet finished. In other words, users don't have to finish a not necessary grouped task, but they still can.}}

{{Hint|The precise status calculation for grouped tasks and their task owners requires the knowledge of all siblings tasks. Imagine 2 out of 3 tasks must be finished but the client only knows 1 in total and the others are only available at the server at that time. This makes it impossible to draw conclusions whether the task(s) should be necessary or not. Under such circumstances, the local status calculation is done as if these are just regular tasks.}}

{{Hint|Like with the other MRO objects, the client always chooses the best available statuses for grouped tasks to present to the users. More specifically, it uses the statuses calculated by the server when the client is not offline and there are no uncommitted local changes on the involved objects. Otherwise, it uses the statuses calculated locally to the best of its knowledge.}}

A task can also be a grouped and a sequential one at the same time. In such a case, the grouped nature of the sibling tasks will affect the way the task sequence completes.

For example, task A1, A2 and A3 are 3 grouped sibling tasks and only 1 of them needs to be finished. At the same time, they are all predecessors of task B. Normally, all predecessors must be finished (and locked) before task B becomes the next one in the sequence and therefore unlocked. In this case, however, as soon as one of the predecessors is finished, all three become unnecessary (and locked) and task B unlocks as a result of that.

==== Supervisor Task {{Version/XamarinSince|4.8}} ====
As the name suggests, supervisor tasks are those that must be finished under supervision. When users want to finish a [[MROCLS_MRO_SUPERVISOR_TASK|supervisor task]], they must hand over their work devices to a supervisor. The latter checks the work status and scans an NFC tag if the work is approved. If the [[MROCLS_MRO_SUPERVISOR|supervisor]] has sufficient permissions for the task and the correct supervisor PIN is given, the task gets unlocked and the users can proceed to finish it.

<gallery widths=300px heights=300px>
File:UI_Xamarin_Supervisor_Task_Before_Verification.jpg|Supervisor Task Before Verification/Unlocking (Mobile)
File:UI_Xamarin_Supervisor_Task_Enter_PIN.jpg|Supervisor Task Enter PIN (Mobile)
File:UI_Xamarin_Supervisor_Task_After_Verification.jpg|Supervisor Task After Verification/Unlocking (Mobile)
</gallery>

A thing to note is that while the need to verify a supervisor task can be seen as a type of locking, it's certainly not the only reason for a [[Locked_Objects|locked object]]. This means a supervisor task can remain locked (although for different reasons) even after a supervisor has successfully verified it. This can often be the case if you use it in combination with other features such as [[MRO_Objects_(Client)#Sequential_Task|sequential tasks]], [[User_Rights|user rights]].

{{Hint|For security reasons, the verification process is cancelled if the supervisor enters the wrong PIN for three times. Scanning the tag again is required in that case.}}
{{Hint|A setting controls [[RFID_tags#Choose_which_information_to_use_from_a_tag|which information in a scanned tag is used]] during this process.}}

==== Signature Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

The Signature Task is a task type that is completed by capturing a handwritten signature from the user. The task contains an editor field that serves as the entry point for the signing process. When the user clicks (or taps) on the editor field, a signature dialog opens. Within this dialog, the user can provide their signature. After confirming the input, the signature is saved and the task is automatically marked as completed.

If the task is signed while the client is online:
* The User (signee) is resolved immediately by the server and displayed.
* The ValidationTimestamp is generated and displayed.
* Both values are shown directly in the editor field after signing.

{{Hint|The User only gets resolved by the server and displayed once you're in online mode}}

If the displayed User and/or ValidationTimestamp cannot be fully shown due to limited space in the editor field, the complete information can be accessed via a Popup.
To show the Popup displaying the full User and ValidationTimestamp without truncation, click on the editor field.

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

==== Picture Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICTURE_TASK|picture task]] is a check task which can only be finished when it has at least one child document containing a valid file. In the UI, an additional photo button is presented next to the check so users can easily take photos before finishing the tasks.
* As any other objects, picture tasks can carry and display [[SYSCLS_CHILDINFOOWNER|child count information]]. But that is not a mandatory part of the feature. Even when it's not configured and not visible in the UI, you can still finish the tasks.
* In WinX/UWP, the UI also presents an expander which allows you to display the child documents of picture tasks. This is not present by default in the Mobile app due to the screen size limit but [[Object_hierarchy_in_XAML:_NextLevel,_ParentLevel,_LinkedLevel#Show_NextLevel_Children.2FDocuments|can be easily customized]].

{{Hint|The task is named as such because pictures are the most commonly used types, but the child documents can be of other types as well. }}

When a user tries to finish a picture task by tapping the check, the app might perform some data synchronization first if in online mode, which includes
* Syncing the child objects (including documents) of the task.
* Downloading the file(s) of the child documents.
During data synchronization, the check button on that task turns into a wait indicator. Afterwards, the app checks if the prerequisites to finish the task are met.
* If there are no child documents or no local files for the child documents, the task remains unfinished and the user gets informed about the reasons.
* Otherwise, the task gets finished and the photo button gets disabled.

{{Hint|Setting NA (not applicable) on a picture task is always possible, regardless of the condition of child documents.}}

==== Numeric Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_MRO_NUMERIC_TASK|numeric task]] is a task which records a double value (e.g. from a temperature sensor). Entering the value (including Not Applicable) completes the task.
* The value is compared against an accaptable value range which is not editable on the client.
* Deviation from this range results in visual feedback as well as the [[#Tech Status|tech status]] being set to display an issue.
* If the configured value range is invalid (e.g. min > max) and the user enters a value, the [[#Tech Status|tech status]] will also be set to display an issue.
* A numeric task also has a special value unit that can be set per task instance. If set, it overrides the standard value unit defined on the [[MetaProperty#Unit_Item|MetaProperty]].

==== Pick List Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICK_LIST_TASK|Pick List task]] looks and behaves the same like a standard Integer Task with SelectiveList. Other than the standard Integer Task, the Pick List Task has an [[UBIK_Active_Lists|Active List]] defined on instance level to pick from for its value property. The task counts as finished as soon as a list item has been selected, or when pressing ''Not Applicable''.

{{DeprecatedStartTag|parameter=Please refer to [[Main_Page]] for the most recent information.}}
=== MRO objects with project information (WinX only) {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}
{{DeprecatedEndTag}}

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

== Locking ==
When an (MRO) object is locked, editing it becomes impossible. More details about [[Locked_Objects|locked objects]].

== See also ==
* [[MRO (Plugin)]]
* [[MROCLS_PROJECT]]
* [[MROCLS_PROJECTINFORMATION]]
* [[MROCLS_SEQUENTIALTASK]]
* [[MROCLS_GROUPEDTASK]]
* [[MROCLS_MRO_CHECK_TASK]]
* [[MROCLS_MRO_INSPECTION_TASK]]
* [[MROCLS_MRO_MEASUREMENT_TASK]]
* [[MROCLS_MRO_PROGRESS_TASK]]
* [[MROCLS_MRO_TASK]]
* [[MROCLS_MRO_TASKOWNER]]
* [[MROCLS_MRO_WORKPACKAGE]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)
* [[MROCLS_PICK_LIST_TASK]] (Classification)

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

MRO Objects (Client)

2026-05-11T12:58:42Z

KGR: /* MRO objects with project information (WinX only) {{Version/WinXSince|2.5.4}} */

[[File:MRO_WinX.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:MRO_MAUI1.jpeg|thumb|alt=MRO Child List UI (Android)|MRO UI (Android)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===

The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

[[File:TechStats_WinX.png|100px|Technical Status Indicator (Winx & Mobile)]]

=== Organisational Status ===
The organisational status indicates the amount of confirmed work within the data branch, including already confirmed work packages as well as tasks that are locked by their owning work package. The organisational status indicator is displayed on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch, and visualizes the amount of confirmed work performed within that branch.
<gallery>
File:OrgaStatusIndicatorWinX.PNG|Organisational Status Indicator (WinX)
File:ConfirmedWP_WinX.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
File:Android_orga_status.PNG|Organisational Status Indicator (Android)
File:ConfirmedWP_MAUI.jpeg|MRO Workpackage Confirmed Indicator (Mobile)
</gallery>

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

=== Work Progress ===
The work progress is calculated from the current work progress and from the progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Version/WinXSince|5.0}} {{Version/MobileSince|5.0}} By default, the progress is displayed with maximum one decimal place. For example, 99.75% is displayed as 99.8%. The format string used to achieve this is <code>{0:0.#}%</code>.

If other numeric formats are preferred in your usecases, you can refer to [https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings custom numeric format strings] for more information. The template to customize for this is the UBIKMROProgressBadge within UBIKThemes.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:ConfirmingWP_WinX.png|MRO Workpackage confirm button (WinX)
File:MRORevoke_WinX.png|MRO Workpackage revoke confirmation button (WinX)
File:ConfirmingWP_MAUI.jpeg|MRO Workpackage confirm button (Android)
File:MRORevoke_MAUI.jpeg|MRO Workpackage revoke confirmation button (Android)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

On both clients, a Task can be reverted by clicking twice on the Not Applicable button.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====

A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

<gallery widths=497px heights=69px>
File:Measurment Task Empty UWP.png|Measurement Task without a reported value (WinX)
File:Measurment Task Not Empty UWP.png|Measurement Task with a reported value (WinX)
File:Measurment Task Empty Android.jpg|Measurement Task without a reported value (Android)
</gallery>

==== Progress Task ====

[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

<gallery widths=497px heights=69px>
File:Progress Task UWP.png|Progress Task with a reported work progress (WinX)
File:Progress Task Android.jpg|Progress Task with a reported work progress and a previous progress(Android)
</gallery>

==== Check Task ====

A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

<gallery widths=497px heights=69px>
File:Check Task finished UWP.png|Unfinished MRO CheckTask (WinX)
File:Check Task android.jpg|Not Applicable MRO CheckTask (Android)
</gallery>

==== Inspection Task ====

[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

<gallery widths=497px heights=69px>
File:Finished Inspection Task UWP.png|Finished MRO InspectionTask (WinX)
File:Inspection task android.jpg|Finished MRO InspectionTask (Android)
</gallery>

==== Sequential Task ====
The [[MROCLS_SEQUENTIALTASK|sequential task classification]] allows you to pre-define a sequence in which tasks are to be resolved by users. This means that it is required for one or multiple tasks to be finished in order for other tasks to become "unlocked" and editable. A task can have any number of "predecessors". Predecessors are the tasks that are required to be finished first.

A task can have predecessors that live anywhere else in the object hierarchy. It is not necessary for a task and its predecessors to be part of the same work package, even though this is likely the most common use case.

The state of a sequential task is evaluated both offline and online to get the best possible user experience. The user will see dependent tasks update immediately if their successors were finished, if those tasks are currently visible in the UI. There is 1 case in which the server-side state will override the client-side (offline) evaluation, discussed below.
The state of each sequential task is evaluated the following way:

# If the server-side state says the task is open, we consider this as the truthful state and don't do any other evaluation.
# Check if the task has any predecessors.
# Try to load each predecessor task.
#* If loading of any predecessor fails (the object is not available offline), the task will be locked.
# If all predecessor tasks are finished, the task is open and can be edited. Otherwise, the task is locked.

The customizer setting up the task dependency relations needs to ensure that the dependencies are not cyclical. In this case, it would be impossible for any tasks in the "cycle" to be finished.

'''Example'''

As a demonstration of this feature, see [[Media:Sequential_tasks_winx.mp4|this video]]. The relations between tasks are defined as in [[Media:Task_relations.png|this image]], starting at A1 and A2, which are not dependent on any other tasks. The lines (from left to right) indicate dependencies. This means that B2 has tasks A1 and A2 as its predecessors, for example.

==== Grouped Task {{Version/WinXSince|4.2}}{{Version/XamarinSince|4.2}} ====
Sometimes, not all tasks have to be finished. More specifically, there might be a predefined condition where you only need to finish a certain number of tasks among a group of them. These are known in {{UBIK}} as [[MROCLS_GROUPEDTASK|grouped tasks]].

The idea is, a group of tasks can be defined as siblings to each other and they also share the same server configured threshold. When the number of finished tasks among that group exceeds the threshold, the entire group is considered as no longer necessary. When reflected in the overall status of the task owner(s), these tasks would appear as if they are finished.

{{Hint|Technically speaking, the finished status is completely independent from the not necessary status on a task. A grouped task which is no longer necessary can be both finished or not yet finished. In other words, users don't have to finish a not necessary grouped task, but they still can.}}

{{Hint|The precise status calculation for grouped tasks and their task owners requires the knowledge of all siblings tasks. Imagine 2 out of 3 tasks must be finished but the client only knows 1 in total and the others are only available at the server at that time. This makes it impossible to draw conclusions whether the task(s) should be necessary or not. Under such circumstances, the local status calculation is done as if these are just regular tasks.}}

{{Hint|Like with the other MRO objects, the client always chooses the best available statuses for grouped tasks to present to the users. More specifically, it uses the statuses calculated by the server when the client is not offline and there are no uncommitted local changes on the involved objects. Otherwise, it uses the statuses calculated locally to the best of its knowledge.}}

A task can also be a grouped and a sequential one at the same time. In such a case, the grouped nature of the sibling tasks will affect the way the task sequence completes.

For example, task A1, A2 and A3 are 3 grouped sibling tasks and only 1 of them needs to be finished. At the same time, they are all predecessors of task B. Normally, all predecessors must be finished (and locked) before task B becomes the next one in the sequence and therefore unlocked. In this case, however, as soon as one of the predecessors is finished, all three become unnecessary (and locked) and task B unlocks as a result of that.

==== Supervisor Task {{Version/XamarinSince|4.8}} ====
As the name suggests, supervisor tasks are those that must be finished under supervision. When users want to finish a [[MROCLS_MRO_SUPERVISOR_TASK|supervisor task]], they must hand over their work devices to a supervisor. The latter checks the work status and scans an NFC tag if the work is approved. If the [[MROCLS_MRO_SUPERVISOR|supervisor]] has sufficient permissions for the task and the correct supervisor PIN is given, the task gets unlocked and the users can proceed to finish it.

<gallery widths=300px heights=300px>
File:UI_Xamarin_Supervisor_Task_Before_Verification.jpg|Supervisor Task Before Verification/Unlocking (Mobile)
File:UI_Xamarin_Supervisor_Task_Enter_PIN.jpg|Supervisor Task Enter PIN (Mobile)
File:UI_Xamarin_Supervisor_Task_After_Verification.jpg|Supervisor Task After Verification/Unlocking (Mobile)
</gallery>

A thing to note is that while the need to verify a supervisor task can be seen as a type of locking, it's certainly not the only reason for a [[Locked_Objects|locked object]]. This means a supervisor task can remain locked (although for different reasons) even after a supervisor has successfully verified it. This can often be the case if you use it in combination with other features such as [[MRO_Objects_(Client)#Sequential_Task|sequential tasks]], [[User_Rights|user rights]].

{{Hint|For security reasons, the verification process is cancelled if the supervisor enters the wrong PIN for three times. Scanning the tag again is required in that case.}}
{{Hint|A setting controls [[RFID_tags#Choose_which_information_to_use_from_a_tag|which information in a scanned tag is used]] during this process.}}

==== Signature Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

The Signature Task is a task type that is completed by capturing a handwritten signature from the user. The task contains an editor field that serves as the entry point for the signing process. When the user clicks (or taps) on the editor field, a signature dialog opens. Within this dialog, the user can provide their signature. After confirming the input, the signature is saved and the task is automatically marked as completed.

If the task is signed while the client is online:
* The User (signee) is resolved immediately by the server and displayed.
* The ValidationTimestamp is generated and displayed.
* Both values are shown directly in the editor field after signing.

{{Hint|The User only gets resolved by the server and displayed once you're in online mode}}

If the displayed User and/or ValidationTimestamp cannot be fully shown due to limited space in the editor field, the complete information can be accessed via a Popup.
To show the Popup displaying the full User and ValidationTimestamp without truncation, click on the editor field.

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

==== Picture Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICTURE_TASK|picture task]] is a check task which can only be finished when it has at least one child document containing a valid file. In the UI, an additional photo button is presented next to the check so users can easily take photos before finishing the tasks.
* As any other objects, picture tasks can carry and display [[SYSCLS_CHILDINFOOWNER|child count information]]. But that is not a mandatory part of the feature. Even when it's not configured and not visible in the UI, you can still finish the tasks.
* In WinX/UWP, the UI also presents an expander which allows you to display the child documents of picture tasks. This is not present by default in the Mobile app due to the screen size limit but [[Object_hierarchy_in_XAML:_NextLevel,_ParentLevel,_LinkedLevel#Show_NextLevel_Children.2FDocuments|can be easily customized]].

{{Hint|The task is named as such because pictures are the most commonly used types, but the child documents can be of other types as well. }}

When a user tries to finish a picture task by tapping the check, the app might perform some data synchronization first if in online mode, which includes
* Syncing the child objects (including documents) of the task.
* Downloading the file(s) of the child documents.
During data synchronization, the check button on that task turns into a wait indicator. Afterwards, the app checks if the prerequisites to finish the task are met.
* If there are no child documents or no local files for the child documents, the task remains unfinished and the user gets informed about the reasons.
* Otherwise, the task gets finished and the photo button gets disabled.

{{Hint|Setting NA (not applicable) on a picture task is always possible, regardless of the condition of child documents.}}

==== Numeric Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_MRO_NUMERIC_TASK|numeric task]] is a task which records a double value (e.g. from a temperature sensor). Entering the value (including Not Applicable) completes the task.
* The value is compared against an accaptable value range which is not editable on the client.
* Deviation from this range results in visual feedback as well as the [[#Tech Status|tech status]] being set to display an issue.
* If the configured value range is invalid (e.g. min > max) and the user enters a value, the [[#Tech Status|tech status]] will also be set to display an issue.
* A numeric task also has a special value unit that can be set per task instance. If set, it overrides the standard value unit defined on the [[MetaProperty#Unit_Item|MetaProperty]].

==== Pick List Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICK_LIST_TASK|Pick List task]] looks and behaves the same like a standard Integer Task with SelectiveList. Other than the standard Integer Task, the Pick List Task has an [[UBIK_Active_Lists|Active List]] defined on instance level to pick from for its value property. The task counts as finished as soon as a list item has been selected, or when pressing ''Not Applicable''.

{{DeprecatedStartTag|parameter=Please refer to [[Main_Page]] for the most recent information.}}
=== MRO objects with project information (WinX only) {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}
{{DeprecatedEndTag}}

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

== Locking ==
When an (MRO) object is locked, editing it becomes impossible. More details about [[Locked_Objects|locked objects]].

== See also ==
* [[MRO (Plugin)]]
* [[MROCLS_PROJECT]]
* [[MROCLS_PROJECTINFORMATION]]
* [[MROCLS_SEQUENTIALTASK]]
* [[MROCLS_GROUPEDTASK]]
* [[MROCLS_MRO_CHECK_TASK]]
* [[MROCLS_MRO_INSPECTION_TASK]]
* [[MROCLS_MRO_MEASUREMENT_TASK]]
* [[MROCLS_MRO_PROGRESS_TASK]]
* [[MROCLS_MRO_TASK]]
* [[MROCLS_MRO_TASKOWNER]]
* [[MROCLS_MRO_WORKPACKAGE]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)
* [[MROCLS_PICK_LIST_TASK]] (Classification)

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

UBIK WinX Client Basics

2026-05-11T11:06:08Z

KGR: /* Properties with value records {{Version/WinXSince|2.5.4}} */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

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

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== 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 and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
==== Saving Indicator ====
[[File:UBIK_SaveIndicator.png|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== Child Page ===

[[File:UBIK_ChildPage.png|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

==== High priority properties ====
High priority properties are properties having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only '''PropertyViewModel.SelectiveItems''', which will return the items of an [[Active_List_Client|ActiveList]], or the items of a MetaProperty.SelectiveList, depending on the server-side configuration. In this case, the [[Converters_In_Mobile#List_of_Available_Converters|SelectiveListToItemsConverter]] is outdated and should not be used anymore.}}

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:ViewEditHistory.png|400px|thumb|Open edit history]]
[[File:PropertyValueRecords.png|400px|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

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

=== Markerless ===

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

The user can 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 ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA 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.

==== 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_WinX_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#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity 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 propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Properties.AllItems}" />
</Grid>
</source>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

Live Values

2026-05-11T10:19:56Z

KGR:

[[File:DisplayLiveValues_Mobile.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:DisplayLiveValues_WinX.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
</gallery>

==Map view==
[[File:LiveValuesMapViewWinX.png |400px|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="250" heights="360">
File:LiveValuesDetailDialog_Mobile.jpg| Fresh live values (Mobile)
File:LiveValuesDetailView.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Pages with broken file links|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

File:DisplayLiveValues WinX.png

2026-05-11T10:19:14Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

File:DisplayLiveValues Mobile.jpg

2026-05-11T10:19:14Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Live Values

2026-05-11T10:14:50Z

KGR: /* Detail dialog */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:LiveValuesMapViewWinX.png |400px|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="250" heights="360">
File:LiveValuesDetailDialog_Mobile.jpg| Fresh live values (Mobile)
File:LiveValuesDetailView.png| Fresh live values (WinX)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Pages with broken file links|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

Live Values

2026-05-11T10:13:37Z

KGR: /* Detail dialog */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:LiveValuesMapViewWinX.png |400px|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:LiveValuesDetailDialog_Mobile.png| Fresh live values (Mobile)
File:LiveValuesDetailView.png| Fresh live values (WinX)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

File:LiveValuesDetailDialog Mobile.jpg

2026-05-11T10:13:06Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Live Values

2026-05-11T10:10:52Z

KGR: /* Connectivity Indicator */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:LiveValuesMapViewWinX.png |400px|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

Live Values

2026-05-11T10:08:40Z

KGR: /* Map view */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
File:LiveValuesDetailView.png| Reliable live values in the details view (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:LiveValuesMapViewWinX.png |400px|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

Live Values

2026-05-11T10:08:10Z

KGR: /* Map view */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
File:LiveValuesDetailView.png| Reliable live values in the details view (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:LiveValuesMapViewWinX.png |200px|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

Live Values

2026-05-11T10:07:31Z

KGR: /* Map view */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
File:LiveValuesDetailView.png| Reliable live values in the details view (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:LiveValuesMapViewWinX.png |thumb|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

File:LiveValuesMapViewWinX.png

2026-05-11T10:07:13Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Live Values

2026-05-11T10:06:22Z

KGR: /* Connectivity Indicator */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, this describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:LiveValues_WinX.png| Reliable live values (Windows)
File:LiveValuesDetailView.png| Reliable live values in the details view (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:UI_android_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Android)]]
[[File:UI_WinX_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

File:LiveValuesDetailView.png

2026-05-11T10:05:34Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

File:LiveValues WinX.png

2026-05-11T10:05:33Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Login View

2026-05-11T09:51:40Z

KGR: /* Profile selection */

For confidentiality reason, users are required to login before they have access to most of the {{UBIK}} features.

== Accessing login view ==
The login view is displayed after starting the app. It is possible to access the login view from every where in the app by pressing the login icon in the top right corner and selecting "log out".

At the top of the screen, the name of the most recently used profile (if any) will be displayed. When pressing "Login" without selecting a different profile first, this profile will automatically be used.

{{Clear}}

== Profile selection ==
[[File:ProfileBrowser.png|300px|thumb|alt=Profile Browser|Profile Browser]]
The name of the currently selected profile is displayed on the top of the view. By default, the last used profile will be selected here.
It is possible to change the profile by pressing the Profile Button. The profile selection flyout will pop up, from which the user can select any profile (see the figure on the right).

To add custom profiles, you must add them under the app's RoamingState folder. You can also categorize your profiles using subfolders within this directory.
You will see 2 different tabs when opening the profile selection view, with the third hidden by default.

=== Favorites ===
The "Favorites" tab shows profiles that the user has marked as favorites. To mark a profile as favorite, simply click the the star icon next to a profile's name. You will see it immediately appearing in the favorites list (sorted alphabetically). You can of course undo this action by simply pressing the star icon again to unmark the profile as favorite.

=== Recent ===
The "Recent" tab shows all available profiles, ordered by most recently used (at the top), to least recently used, excluding favorited profiles (which appear in the "Favorites" tab). When you click a profile anywhere in the selection view, it will be timestamped, and added to the top of the "Recent" tab.

=== Browser ===
To view the "Browser" tab, the user can click the expansion button on the right side to toggle the tab open or closed.
The "Browser" tab shows all available profiles (including favorites), but displays them exactly as your file browser would, including sub folders. The user can navigate through sub folders simply by clicking them.

{{Clear}}

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

== Login ==

=== UWP older versions ===
[[File:UI_WinX_Login_Dialog.png|thumb|alt=Login Dialog|Login Dialog]]
The login dialog is opened by pressing the Login button. The dialog also opens automatically after selecting a profile.
The first time the user uses a single profile to connect to a service, he is asked whether the system should remember login and password (for the user and profile). If the user selects yes, the login dialog will not appear again and the credentials are used immediately the next time he connects by using the profile. If the user selects no, he has to enter his credentials every time.

=== UWP{{Version/WinXSince|3.6}} & Mobile clients ===
<gallery widths="350" heights="300">
File:LoginView_WinX.png|UBIK UWP{{Version/WinXSince|3.6}}
File:LoginViewUBIKGO.jpg|UBIK Mobile
</gallery>
{{UBIK}} can remember multiple users per profile. By default, the last remembered one for the selected profile is used. And as you type in a different username, {{UBIK}} constantly checks whether it is a remembered user. If so, the password is automatically filled so that you don't have to.
* A user can only be remembered after a successful online login, namely the username and password must be authenticated at least once by the server;
* If a new password is entered for a remembered user and it is authenticated by the server, the remembered one will be updated;
* By unchecking the remembering option and logging in, the remembered user will be "forgotten". This is also possible without a server authentication. Afterwards, offline login is still possible for this user.

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

=== Offline Login ===
Every successful online login is stored. The stored credentials are used for supporting offline logins.
{{Hint|You can access a local database without online connection (offline) when the credentials were used once to connect successfully to the online service.}}

=== Clear Cache ===
The clear cache feature (settings) deletes all the remembered credentials (login and password) from the system.
{{Attention|Offline logins are not possible after clearing the cache until the user connected once at the online service.}}

== Team login {{Version/WinXSince|2.6.1}} ==
{{Attention|This feature is now obselete.}}

[[File:UI_WinX_Team_Login_Button.png|thumb|alt=Team Login Button|Team Login Button]]
[[File:UI_WinX_Team_Login_Dialog.png|thumb|alt=Team Login Dialog|Team Login Dialog]]
Team login allows a group of users to login with a single device and perform tasks together as a team.

=== Team login button ===
{{Attention|This button is not available by default in the app, certain custom templates are needed for this. An example template can be downloaded {{FileLink|xaml_262_20170310_Team_Login_Button.zip|here}}.}}

=== Team login dialog ===
The team login dialog has the following parts:
# Profile selector to change profiles;
#Team member list (each member has a remove button at the right side);
# {{key press|+}} button to add members;
# {{key press|Login}} button;
# {{key press|Close}} button.
The same [[Login_View#Login_Dialog|login dialog]] shows up once the {{key press|+}} button is pressed and the members should enter their credentials one by one. Once all the members are successfully added, press the {{key press|Login}} button to login as a team.
{{Hint|All members in a team should login to the same service, namely using the same profile. Therefore, the profile selector will be disabled as long as the member list is not empty.}}

== Login details ==

{{Version/WinXSince|3.8}}{{Version/XamarinSince|1.2}}, it's possible for the client to receive login details of the current user as well as other users.
Currently, that information is not displayed in the default UI. However, it's accessible under the globally available AppStatus through XAML customizing.
* AppStatus.CurrentLogin: The current login instance;
* AppStatus.AllLogins: All available login instances;
* AppStatus.UpdateLoginDetailsCommand.
It is recommended to use the [[Developer_Mode#Browsing_the_ViewModel.2FContext|developer mode]] to inspect what can be expected from each of these.

Technically speaking, the full login details come from the two following sources.

=== Current login ===
The client contacts the web service for the basic information of the currently logged-in user when switched to non-offline sync modes.
* UID: uniquely identifies the login/user;
* LoginName: name of the login/user;
* Image: user icon or profile image;
* DisplayStrings: descriptive texts.
This information is persisted in the database, therefore, also available offline as long as you have logged in online once.

=== Login instances ===
[[SYSCLS_LOGIN|Login instances]] can be delivered just as any {{UBIK}} content to the client. They can carry any amount of information which is accessible through RawDetails - a key value dictionary.

{{Hint|If available, the instance matching the current login's UID will be used to extend the available login details. It's possible to have duplicate information in the current login, e.g. LoginName available from direct web service communication as well as the same named property through RawDetails. In such a case, it's recommended to take the former over the latter.}}

== Commands ==

=== Login related ===
Three commands are available for logging in/out.
* LogoutCommand;
* LoginCommand;
* ToggleLoginCommand: Log out if you are already logged in, log in otherwise.

<tabs>
LoginCommand and ToggleLoginCommand support an additional command parameter to automatically navigate to the root page after a successful login.
The parameter can be both a simple boolean value, or a KeyValueList with a boolean value under the key of "NavigateToRootPageOnLogin". See examples below.
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

Login View

2026-05-11T09:51:08Z

KGR: /* Profile selection */

For confidentiality reason, users are required to login before they have access to most of the {{UBIK}} features.

== Accessing login view ==
The login view is displayed after starting the app. It is possible to access the login view from every where in the app by pressing the login icon in the top right corner and selecting "log out".

At the top of the screen, the name of the most recently used profile (if any) will be displayed. When pressing "Login" without selecting a different profile first, this profile will automatically be used.

{{Clear}}

== Profile selection ==
[[File:ProfileBrowser.png|400px|thumb|alt=Profile Browser|Profile Browser]]
The name of the currently selected profile is displayed on the top of the view. By default, the last used profile will be selected here.
It is possible to change the profile by pressing the Profile Button. The profile selection flyout will pop up, from which the user can select any profile (see the figure on the right).

To add custom profiles, you must add them under the app's RoamingState folder. You can also categorize your profiles using subfolders within this directory.
You will see 2 different tabs when opening the profile selection view, with the third hidden by default.

=== Favorites ===
The "Favorites" tab shows profiles that the user has marked as favorites. To mark a profile as favorite, simply click the the star icon next to a profile's name. You will see it immediately appearing in the favorites list (sorted alphabetically). You can of course undo this action by simply pressing the star icon again to unmark the profile as favorite.

=== Recent ===
The "Recent" tab shows all available profiles, ordered by most recently used (at the top), to least recently used, excluding favorited profiles (which appear in the "Favorites" tab). When you click a profile anywhere in the selection view, it will be timestamped, and added to the top of the "Recent" tab.

=== Browser ===
To view the "Browser" tab, the user can click the expansion button on the right side to toggle the tab open or closed.
The "Browser" tab shows all available profiles (including favorites), but displays them exactly as your file browser would, including sub folders. The user can navigate through sub folders simply by clicking them.

{{Clear}}

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

== Login ==

=== UWP older versions ===
[[File:UI_WinX_Login_Dialog.png|thumb|alt=Login Dialog|Login Dialog]]
The login dialog is opened by pressing the Login button. The dialog also opens automatically after selecting a profile.
The first time the user uses a single profile to connect to a service, he is asked whether the system should remember login and password (for the user and profile). If the user selects yes, the login dialog will not appear again and the credentials are used immediately the next time he connects by using the profile. If the user selects no, he has to enter his credentials every time.

=== UWP{{Version/WinXSince|3.6}} & Mobile clients ===
<gallery widths="350" heights="300">
File:LoginView_WinX.png|UBIK UWP{{Version/WinXSince|3.6}}
File:LoginViewUBIKGO.jpg|UBIK Mobile
</gallery>
{{UBIK}} can remember multiple users per profile. By default, the last remembered one for the selected profile is used. And as you type in a different username, {{UBIK}} constantly checks whether it is a remembered user. If so, the password is automatically filled so that you don't have to.
* A user can only be remembered after a successful online login, namely the username and password must be authenticated at least once by the server;
* If a new password is entered for a remembered user and it is authenticated by the server, the remembered one will be updated;
* By unchecking the remembering option and logging in, the remembered user will be "forgotten". This is also possible without a server authentication. Afterwards, offline login is still possible for this user.

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

=== Offline Login ===
Every successful online login is stored. The stored credentials are used for supporting offline logins.
{{Hint|You can access a local database without online connection (offline) when the credentials were used once to connect successfully to the online service.}}

=== Clear Cache ===
The clear cache feature (settings) deletes all the remembered credentials (login and password) from the system.
{{Attention|Offline logins are not possible after clearing the cache until the user connected once at the online service.}}

== Team login {{Version/WinXSince|2.6.1}} ==
{{Attention|This feature is now obselete.}}

[[File:UI_WinX_Team_Login_Button.png|thumb|alt=Team Login Button|Team Login Button]]
[[File:UI_WinX_Team_Login_Dialog.png|thumb|alt=Team Login Dialog|Team Login Dialog]]
Team login allows a group of users to login with a single device and perform tasks together as a team.

=== Team login button ===
{{Attention|This button is not available by default in the app, certain custom templates are needed for this. An example template can be downloaded {{FileLink|xaml_262_20170310_Team_Login_Button.zip|here}}.}}

=== Team login dialog ===
The team login dialog has the following parts:
# Profile selector to change profiles;
#Team member list (each member has a remove button at the right side);
# {{key press|+}} button to add members;
# {{key press|Login}} button;
# {{key press|Close}} button.
The same [[Login_View#Login_Dialog|login dialog]] shows up once the {{key press|+}} button is pressed and the members should enter their credentials one by one. Once all the members are successfully added, press the {{key press|Login}} button to login as a team.
{{Hint|All members in a team should login to the same service, namely using the same profile. Therefore, the profile selector will be disabled as long as the member list is not empty.}}

== Login details ==

{{Version/WinXSince|3.8}}{{Version/XamarinSince|1.2}}, it's possible for the client to receive login details of the current user as well as other users.
Currently, that information is not displayed in the default UI. However, it's accessible under the globally available AppStatus through XAML customizing.
* AppStatus.CurrentLogin: The current login instance;
* AppStatus.AllLogins: All available login instances;
* AppStatus.UpdateLoginDetailsCommand.
It is recommended to use the [[Developer_Mode#Browsing_the_ViewModel.2FContext|developer mode]] to inspect what can be expected from each of these.

Technically speaking, the full login details come from the two following sources.

=== Current login ===
The client contacts the web service for the basic information of the currently logged-in user when switched to non-offline sync modes.
* UID: uniquely identifies the login/user;
* LoginName: name of the login/user;
* Image: user icon or profile image;
* DisplayStrings: descriptive texts.
This information is persisted in the database, therefore, also available offline as long as you have logged in online once.

=== Login instances ===
[[SYSCLS_LOGIN|Login instances]] can be delivered just as any {{UBIK}} content to the client. They can carry any amount of information which is accessible through RawDetails - a key value dictionary.

{{Hint|If available, the instance matching the current login's UID will be used to extend the available login details. It's possible to have duplicate information in the current login, e.g. LoginName available from direct web service communication as well as the same named property through RawDetails. In such a case, it's recommended to take the former over the latter.}}

== Commands ==

=== Login related ===
Three commands are available for logging in/out.
* LogoutCommand;
* LoginCommand;
* ToggleLoginCommand: Log out if you are already logged in, log in otherwise.

<tabs>
LoginCommand and ToggleLoginCommand support an additional command parameter to automatically navigate to the root page after a successful login.
The parameter can be both a simple boolean value, or a KeyValueList with a boolean value under the key of "NavigateToRootPageOnLogin". See examples below.
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

MRO Objects (Client)

2026-05-11T09:47:57Z

KGR: /* Organisational Status */

[[File:MRO_WinX.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:MRO_MAUI1.jpeg|thumb|alt=MRO Child List UI (Android)|MRO UI (Android)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===

The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

[[File:TechStats_WinX.png|100px|Technical Status Indicator (Winx & Mobile)]]

=== Organisational Status ===
The organisational status indicates the amount of confirmed work within the data branch, including already confirmed work packages as well as tasks that are locked by their owning work package. The organisational status indicator is displayed on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch, and visualizes the amount of confirmed work performed within that branch.
<gallery>
File:OrgStatusIndicator.png|Organisational Status Indicator (WinX)
File:ConfirmedWP_WinX.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
File:Android_orga_status.PNG|Organisational Status Indicator (Android)
File:ConfirmedWP_MAUI.jpeg|MRO Workpackage Confirmed Indicator (Mobile)
</gallery>

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

=== Work Progress ===
The work progress is calculated from the current work progress and from the progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Version/WinXSince|5.0}} {{Version/MobileSince|5.0}} By default, the progress is displayed with maximum one decimal place. For example, 99.75% is displayed as 99.8%. The format string used to achieve this is <code>{0:0.#}%</code>.

If other numeric formats are preferred in your usecases, you can refer to [https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings custom numeric format strings] for more information. The template to customize for this is the UBIKMROProgressBadge within UBIKThemes.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:ConfirmingWP_WinX.png|MRO Workpackage confirm button (WinX)
File:MRORevoke_WinX.png|MRO Workpackage revoke confirmation button (WinX)
File:ConfirmingWP_MAUI.jpeg|MRO Workpackage confirm button (Android)
File:MRORevoke_MAUI.jpeg|MRO Workpackage revoke confirmation button (Android)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

On both clients, a Task can be reverted by clicking twice on the Not Applicable button.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====

A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

<gallery widths=497px heights=69px>
File:Measurment Task Empty UWP.png|Measurement Task without a reported value (WinX)
File:Measurment Task Not Empty UWP.png|Measurement Task with a reported value (WinX)
File:Measurment Task Empty Android.jpg|Measurement Task without a reported value (Android)
</gallery>

==== Progress Task ====

[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

<gallery widths=497px heights=69px>
File:Progress Task UWP.png|Progress Task with a reported work progress (WinX)
File:Progress Task Android.jpg|Progress Task with a reported work progress and a previous progress(Android)
</gallery>

==== Check Task ====

A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

<gallery widths=497px heights=69px>
File:Check Task finished UWP.png|Unfinished MRO CheckTask (WinX)
File:Check Task android.jpg|Not Applicable MRO CheckTask (Android)
</gallery>

==== Inspection Task ====

[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

<gallery widths=497px heights=69px>
File:Finished Inspection Task UWP.png|Finished MRO InspectionTask (WinX)
File:Inspection task android.jpg|Finished MRO InspectionTask (Android)
</gallery>

==== Sequential Task ====
The [[MROCLS_SEQUENTIALTASK|sequential task classification]] allows you to pre-define a sequence in which tasks are to be resolved by users. This means that it is required for one or multiple tasks to be finished in order for other tasks to become "unlocked" and editable. A task can have any number of "predecessors". Predecessors are the tasks that are required to be finished first.

A task can have predecessors that live anywhere else in the object hierarchy. It is not necessary for a task and its predecessors to be part of the same work package, even though this is likely the most common use case.

The state of a sequential task is evaluated both offline and online to get the best possible user experience. The user will see dependent tasks update immediately if their successors were finished, if those tasks are currently visible in the UI. There is 1 case in which the server-side state will override the client-side (offline) evaluation, discussed below.
The state of each sequential task is evaluated the following way:

# If the server-side state says the task is open, we consider this as the truthful state and don't do any other evaluation.
# Check if the task has any predecessors.
# Try to load each predecessor task.
#* If loading of any predecessor fails (the object is not available offline), the task will be locked.
# If all predecessor tasks are finished, the task is open and can be edited. Otherwise, the task is locked.

The customizer setting up the task dependency relations needs to ensure that the dependencies are not cyclical. In this case, it would be impossible for any tasks in the "cycle" to be finished.

'''Example'''

As a demonstration of this feature, see [[Media:Sequential_tasks_winx.mp4|this video]]. The relations between tasks are defined as in [[Media:Task_relations.png|this image]], starting at A1 and A2, which are not dependent on any other tasks. The lines (from left to right) indicate dependencies. This means that B2 has tasks A1 and A2 as its predecessors, for example.

==== Grouped Task {{Version/WinXSince|4.2}}{{Version/XamarinSince|4.2}} ====
Sometimes, not all tasks have to be finished. More specifically, there might be a predefined condition where you only need to finish a certain number of tasks among a group of them. These are known in {{UBIK}} as [[MROCLS_GROUPEDTASK|grouped tasks]].

The idea is, a group of tasks can be defined as siblings to each other and they also share the same server configured threshold. When the number of finished tasks among that group exceeds the threshold, the entire group is considered as no longer necessary. When reflected in the overall status of the task owner(s), these tasks would appear as if they are finished.

{{Hint|Technically speaking, the finished status is completely independent from the not necessary status on a task. A grouped task which is no longer necessary can be both finished or not yet finished. In other words, users don't have to finish a not necessary grouped task, but they still can.}}

{{Hint|The precise status calculation for grouped tasks and their task owners requires the knowledge of all siblings tasks. Imagine 2 out of 3 tasks must be finished but the client only knows 1 in total and the others are only available at the server at that time. This makes it impossible to draw conclusions whether the task(s) should be necessary or not. Under such circumstances, the local status calculation is done as if these are just regular tasks.}}

{{Hint|Like with the other MRO objects, the client always chooses the best available statuses for grouped tasks to present to the users. More specifically, it uses the statuses calculated by the server when the client is not offline and there are no uncommitted local changes on the involved objects. Otherwise, it uses the statuses calculated locally to the best of its knowledge.}}

A task can also be a grouped and a sequential one at the same time. In such a case, the grouped nature of the sibling tasks will affect the way the task sequence completes.

For example, task A1, A2 and A3 are 3 grouped sibling tasks and only 1 of them needs to be finished. At the same time, they are all predecessors of task B. Normally, all predecessors must be finished (and locked) before task B becomes the next one in the sequence and therefore unlocked. In this case, however, as soon as one of the predecessors is finished, all three become unnecessary (and locked) and task B unlocks as a result of that.

==== Supervisor Task {{Version/XamarinSince|4.8}} ====
As the name suggests, supervisor tasks are those that must be finished under supervision. When users want to finish a [[MROCLS_MRO_SUPERVISOR_TASK|supervisor task]], they must hand over their work devices to a supervisor. The latter checks the work status and scans an NFC tag if the work is approved. If the [[MROCLS_MRO_SUPERVISOR|supervisor]] has sufficient permissions for the task and the correct supervisor PIN is given, the task gets unlocked and the users can proceed to finish it.

<gallery widths=300px heights=300px>
File:UI_Xamarin_Supervisor_Task_Before_Verification.jpg|Supervisor Task Before Verification/Unlocking (Mobile)
File:UI_Xamarin_Supervisor_Task_Enter_PIN.jpg|Supervisor Task Enter PIN (Mobile)
File:UI_Xamarin_Supervisor_Task_After_Verification.jpg|Supervisor Task After Verification/Unlocking (Mobile)
</gallery>

A thing to note is that while the need to verify a supervisor task can be seen as a type of locking, it's certainly not the only reason for a [[Locked_Objects|locked object]]. This means a supervisor task can remain locked (although for different reasons) even after a supervisor has successfully verified it. This can often be the case if you use it in combination with other features such as [[MRO_Objects_(Client)#Sequential_Task|sequential tasks]], [[User_Rights|user rights]].

{{Hint|For security reasons, the verification process is cancelled if the supervisor enters the wrong PIN for three times. Scanning the tag again is required in that case.}}
{{Hint|A setting controls [[RFID_tags#Choose_which_information_to_use_from_a_tag|which information in a scanned tag is used]] during this process.}}

==== Signature Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

The Signature Task is a task type that is completed by capturing a handwritten signature from the user. The task contains an editor field that serves as the entry point for the signing process. When the user clicks (or taps) on the editor field, a signature dialog opens. Within this dialog, the user can provide their signature. After confirming the input, the signature is saved and the task is automatically marked as completed.

If the task is signed while the client is online:
* The User (signee) is resolved immediately by the server and displayed.
* The ValidationTimestamp is generated and displayed.
* Both values are shown directly in the editor field after signing.

{{Hint|The User only gets resolved by the server and displayed once you're in online mode}}

If the displayed User and/or ValidationTimestamp cannot be fully shown due to limited space in the editor field, the complete information can be accessed via a Popup.
To show the Popup displaying the full User and ValidationTimestamp without truncation, click on the editor field.

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

==== Picture Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICTURE_TASK|picture task]] is a check task which can only be finished when it has at least one child document containing a valid file. In the UI, an additional photo button is presented next to the check so users can easily take photos before finishing the tasks.
* As any other objects, picture tasks can carry and display [[SYSCLS_CHILDINFOOWNER|child count information]]. But that is not a mandatory part of the feature. Even when it's not configured and not visible in the UI, you can still finish the tasks.
* In WinX/UWP, the UI also presents an expander which allows you to display the child documents of picture tasks. This is not present by default in the Mobile app due to the screen size limit but [[Object_hierarchy_in_XAML:_NextLevel,_ParentLevel,_LinkedLevel#Show_NextLevel_Children.2FDocuments|can be easily customized]].

{{Hint|The task is named as such because pictures are the most commonly used types, but the child documents can be of other types as well. }}

When a user tries to finish a picture task by tapping the check, the app might perform some data synchronization first if in online mode, which includes
* Syncing the child objects (including documents) of the task.
* Downloading the file(s) of the child documents.
During data synchronization, the check button on that task turns into a wait indicator. Afterwards, the app checks if the prerequisites to finish the task are met.
* If there are no child documents or no local files for the child documents, the task remains unfinished and the user gets informed about the reasons.
* Otherwise, the task gets finished and the photo button gets disabled.

{{Hint|Setting NA (not applicable) on a picture task is always possible, regardless of the condition of child documents.}}

==== Numeric Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_MRO_NUMERIC_TASK|numeric task]] is a task which records a double value (e.g. from a temperature sensor). Entering the value (including Not Applicable) completes the task.
* The value is compared against an accaptable value range which is not editable on the client.
* Deviation from this range results in visual feedback as well as the [[#Tech Status|tech status]] being set to display an issue.
* If the configured value range is invalid (e.g. min > max) and the user enters a value, the [[#Tech Status|tech status]] will also be set to display an issue.
* A numeric task also has a special value unit that can be set per task instance. If set, it overrides the standard value unit defined on the [[MetaProperty#Unit_Item|MetaProperty]].

==== Pick List Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICK_LIST_TASK|Pick List task]] looks and behaves the same like a standard Integer Task with SelectiveList. Other than the standard Integer Task, the Pick List Task has an [[UBIK_Active_Lists|Active List]] defined on instance level to pick from for its value property. The task counts as finished as soon as a list item has been selected, or when pressing ''Not Applicable''.

=== MRO objects with project information (WinX only) {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}

== Locking ==
When an (MRO) object is locked, editing it becomes impossible. More details about [[Locked_Objects|locked objects]].

== See also ==
* [[MRO (Plugin)]]
* [[MROCLS_PROJECT]]
* [[MROCLS_PROJECTINFORMATION]]
* [[MROCLS_SEQUENTIALTASK]]
* [[MROCLS_GROUPEDTASK]]
* [[MROCLS_MRO_CHECK_TASK]]
* [[MROCLS_MRO_INSPECTION_TASK]]
* [[MROCLS_MRO_MEASUREMENT_TASK]]
* [[MROCLS_MRO_PROGRESS_TASK]]
* [[MROCLS_MRO_TASK]]
* [[MROCLS_MRO_TASKOWNER]]
* [[MROCLS_MRO_WORKPACKAGE]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)
* [[MROCLS_PICK_LIST_TASK]] (Classification)

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

File:OrgStatusIndicator.png

2026-05-11T09:47:40Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

MRO Objects (Client)

2026-05-11T09:44:31Z

KGR: /* Organisational Status */

[[File:MRO_WinX.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:MRO_MAUI1.jpeg|thumb|alt=MRO Child List UI (Android)|MRO UI (Android)]]
The WinX client UI displays MRO configured objects like any other root- or child-object enriched by some additional logic and features.

== Basic User Interface ==
The representation of MRO features comprises some indicators and interactive controls. In the {{UBIK}} child list, the main object displays cumulated technical and organisational status as well as the overall work progress based on the underlying data branch. Objects classified as MRO objects in general provide indicators for the MRO status. This means the status is shown next to the main icon of a child-/details-/documents-page as well as next to the icons of the child list items:

=== Technical Status ===

The technical status indicator is shown on all objects that represent a technical state or receive the technical status from subsequent objects in the underlying data branch. If e.g. a inventory object is reported as damaged, its parent objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.

[[File:TechStats_WinX.png|100px|Technical Status Indicator (Winx & Mobile)]]

=== Organisational Status ===
The organisational status indicates the amount of confirmed work within the data branch, including already confirmed work packages as well as tasks that are locked by their owning work package. The organisational status indicator is displayed on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch, and visualizes the amount of confirmed work performed within that branch.
<gallery>
File:OrganisationaleStatus.png|Organisational Status Indicator (WinX)
File:ConfirmedWP_WinX.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
File:Android_orga_status.PNG|Organisational Status Indicator (Android)
File:ConfirmedWP_MAUI.jpeg|MRO Workpackage Confirmed Indicator (Mobile)
</gallery>

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

=== Work Progress ===
The work progress is calculated from the current work progress and from the progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

{{Version/WinXSince|5.0}} {{Version/MobileSince|5.0}} By default, the progress is displayed with maximum one decimal place. For example, 99.75% is displayed as 99.8%. The format string used to achieve this is <code>{0:0.#}%</code>.

If other numeric formats are preferred in your usecases, you can refer to [https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings custom numeric format strings] for more information. The template to customize for this is the UBIKMROProgressBadge within UBIKThemes.

{{Clear}}

== MRO Objects ==
A set of specific objects can be used to provide the required structure for MRO:

=== Task Owner ===
A [[MROCLS_MRO_TASKOWNER|Task Owner]] is an object having a substructure of jobs to be done. It can have a tree of other task owners or work packages underneath that will update the status of the task owner. This status consists of technical, organisational and progress information. With a task owner a user can get an overview of all the work to be done in the underlying job structure.

=== Work Package===
A [[MROCLS_MRO_WORKPACKAGE|Work Package]] is a collection of objects to collect and summarize other task owning objects, workpackages, or tasks. A simple workpackage has a certain amount of tasks that have to be finished in order to confirm the workpackage as done. More complex workpackages can also own other underlying workpackages that have to be confirmed. Confirming a workpackage itself requires a progress of 100% of all related tasks, as well as 100% confirmed sub work packages.

<gallery>
File:ConfirmingWP_WinX.png|MRO Workpackage confirm button (WinX)
File:MRORevoke_WinX.png|MRO Workpackage revoke confirmation button (WinX)
File:ConfirmingWP_MAUI.jpeg|MRO Workpackage confirm button (Android)
File:MRORevoke_MAUI.jpeg|MRO Workpackage revoke confirmation button (Android)
</gallery>

=== Task ===
A [[MROCLS_MRO_TASK|Task]] is an object reporting a certain progress to the owning workpackage. There are several specialized types of task objects. All kinds of tasks have a property called '''VALUE''' in common. It is very important, that this property is able to be validated. Therefore, a MetaAttribute (providing a validation timestamp by default) has to be attached on the used MetaProperty.

On both clients, a Task can be reverted by clicking twice on the Not Applicable button.

{{Attention|The MetaProperty ''VALUE'' has to use [[Attributes]] in order to be validated. Otherwise, the calculation of work progress will not be possible.}}

==== Measurement Task ====

A [[MROCLS_MRO_MEASUREMENT_TASK|Measurement Task]] inherits from [[MROCLS_MRO_TASK|Task]] and documents a measured value (e.g. read from a pressure gauge). Therefore, clicking the value on the shown task opens an editor to enter the desired value. If no value was entered before, an empty line will be shown. Once a value has been entered, the task is finished. Alternatively, the task can also be closed by the option ''Not Applicable'' to document the situation of not being able to fullfill the measurement (e.g. the pressure gauge is broken). An additional small value indicator below the main value can report e.g. the previously entered value. The behaviour of this previous value indicator has to be specified separately in the customizing.
{{Clear}}

<gallery widths=497px heights=69px>
File:Measurment Task Empty UWP.png|Measurement Task without a reported value (WinX)
File:Measurment Task Not Empty UWP.png|Measurement Task with a reported value (WinX)
File:Measurment Task Empty Android.jpg|Measurement Task without a reported value (Android)
</gallery>

==== Progress Task ====

[[MROCLS_MRO_PROGRESS_TASK| Progress Task]] inherits from [[MROCLS_MRO_MEASUREMENT_TASK|Task]] and reports a certain progress while fullfilling a task. The progress will influence the overall progress of the owning workpackage. If the task cannot be fullfilled, it can also be finished with the option ''Not Applicable''.

There is also an [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] available for progress tasks.{{Version/WinXSince|2.5.4}}
{{Clear}}

<gallery widths=497px heights=69px>
File:Progress Task UWP.png|Progress Task with a reported work progress (WinX)
File:Progress Task Android.jpg|Progress Task with a reported work progress and a previous progress(Android)
</gallery>

==== Check Task ====

A [[MROCLS_MRO_CHECK_TASK|Check Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished by reporting ''Done'' or ''Not Applicable''. This is intended for a simple To-Do task that is either done or not.
{{Clear}}

<gallery widths=497px heights=69px>
File:Check Task finished UWP.png|Unfinished MRO CheckTask (WinX)
File:Check Task android.jpg|Not Applicable MRO CheckTask (Android)
</gallery>

==== Inspection Task ====

[[MROCLS_MRO_INSPECTION_TASK|Inspection Task]] inherits from [[MROCLS_MRO_TASK|Task]] and is finished, when the user reports with a positive or negative answer or ''Not Applicable'' (e.g. reporting a yes/no answer for existing equipment).
{{Clear}}

<gallery widths=497px heights=69px>
File:Finished Inspection Task UWP.png|Finished MRO InspectionTask (WinX)
File:Inspection task android.jpg|Finished MRO InspectionTask (Android)
</gallery>

==== Sequential Task ====
The [[MROCLS_SEQUENTIALTASK|sequential task classification]] allows you to pre-define a sequence in which tasks are to be resolved by users. This means that it is required for one or multiple tasks to be finished in order for other tasks to become "unlocked" and editable. A task can have any number of "predecessors". Predecessors are the tasks that are required to be finished first.

A task can have predecessors that live anywhere else in the object hierarchy. It is not necessary for a task and its predecessors to be part of the same work package, even though this is likely the most common use case.

The state of a sequential task is evaluated both offline and online to get the best possible user experience. The user will see dependent tasks update immediately if their successors were finished, if those tasks are currently visible in the UI. There is 1 case in which the server-side state will override the client-side (offline) evaluation, discussed below.
The state of each sequential task is evaluated the following way:

# If the server-side state says the task is open, we consider this as the truthful state and don't do any other evaluation.
# Check if the task has any predecessors.
# Try to load each predecessor task.
#* If loading of any predecessor fails (the object is not available offline), the task will be locked.
# If all predecessor tasks are finished, the task is open and can be edited. Otherwise, the task is locked.

The customizer setting up the task dependency relations needs to ensure that the dependencies are not cyclical. In this case, it would be impossible for any tasks in the "cycle" to be finished.

'''Example'''

As a demonstration of this feature, see [[Media:Sequential_tasks_winx.mp4|this video]]. The relations between tasks are defined as in [[Media:Task_relations.png|this image]], starting at A1 and A2, which are not dependent on any other tasks. The lines (from left to right) indicate dependencies. This means that B2 has tasks A1 and A2 as its predecessors, for example.

==== Grouped Task {{Version/WinXSince|4.2}}{{Version/XamarinSince|4.2}} ====
Sometimes, not all tasks have to be finished. More specifically, there might be a predefined condition where you only need to finish a certain number of tasks among a group of them. These are known in {{UBIK}} as [[MROCLS_GROUPEDTASK|grouped tasks]].

The idea is, a group of tasks can be defined as siblings to each other and they also share the same server configured threshold. When the number of finished tasks among that group exceeds the threshold, the entire group is considered as no longer necessary. When reflected in the overall status of the task owner(s), these tasks would appear as if they are finished.

{{Hint|Technically speaking, the finished status is completely independent from the not necessary status on a task. A grouped task which is no longer necessary can be both finished or not yet finished. In other words, users don't have to finish a not necessary grouped task, but they still can.}}

{{Hint|The precise status calculation for grouped tasks and their task owners requires the knowledge of all siblings tasks. Imagine 2 out of 3 tasks must be finished but the client only knows 1 in total and the others are only available at the server at that time. This makes it impossible to draw conclusions whether the task(s) should be necessary or not. Under such circumstances, the local status calculation is done as if these are just regular tasks.}}

{{Hint|Like with the other MRO objects, the client always chooses the best available statuses for grouped tasks to present to the users. More specifically, it uses the statuses calculated by the server when the client is not offline and there are no uncommitted local changes on the involved objects. Otherwise, it uses the statuses calculated locally to the best of its knowledge.}}

A task can also be a grouped and a sequential one at the same time. In such a case, the grouped nature of the sibling tasks will affect the way the task sequence completes.

For example, task A1, A2 and A3 are 3 grouped sibling tasks and only 1 of them needs to be finished. At the same time, they are all predecessors of task B. Normally, all predecessors must be finished (and locked) before task B becomes the next one in the sequence and therefore unlocked. In this case, however, as soon as one of the predecessors is finished, all three become unnecessary (and locked) and task B unlocks as a result of that.

==== Supervisor Task {{Version/XamarinSince|4.8}} ====
As the name suggests, supervisor tasks are those that must be finished under supervision. When users want to finish a [[MROCLS_MRO_SUPERVISOR_TASK|supervisor task]], they must hand over their work devices to a supervisor. The latter checks the work status and scans an NFC tag if the work is approved. If the [[MROCLS_MRO_SUPERVISOR|supervisor]] has sufficient permissions for the task and the correct supervisor PIN is given, the task gets unlocked and the users can proceed to finish it.

<gallery widths=300px heights=300px>
File:UI_Xamarin_Supervisor_Task_Before_Verification.jpg|Supervisor Task Before Verification/Unlocking (Mobile)
File:UI_Xamarin_Supervisor_Task_Enter_PIN.jpg|Supervisor Task Enter PIN (Mobile)
File:UI_Xamarin_Supervisor_Task_After_Verification.jpg|Supervisor Task After Verification/Unlocking (Mobile)
</gallery>

A thing to note is that while the need to verify a supervisor task can be seen as a type of locking, it's certainly not the only reason for a [[Locked_Objects|locked object]]. This means a supervisor task can remain locked (although for different reasons) even after a supervisor has successfully verified it. This can often be the case if you use it in combination with other features such as [[MRO_Objects_(Client)#Sequential_Task|sequential tasks]], [[User_Rights|user rights]].

{{Hint|For security reasons, the verification process is cancelled if the supervisor enters the wrong PIN for three times. Scanning the tag again is required in that case.}}
{{Hint|A setting controls [[RFID_tags#Choose_which_information_to_use_from_a_tag|which information in a scanned tag is used]] during this process.}}

==== Signature Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

The Signature Task is a task type that is completed by capturing a handwritten signature from the user. The task contains an editor field that serves as the entry point for the signing process. When the user clicks (or taps) on the editor field, a signature dialog opens. Within this dialog, the user can provide their signature. After confirming the input, the signature is saved and the task is automatically marked as completed.

If the task is signed while the client is online:
* The User (signee) is resolved immediately by the server and displayed.
* The ValidationTimestamp is generated and displayed.
* Both values are shown directly in the editor field after signing.

{{Hint|The User only gets resolved by the server and displayed once you're in online mode}}

If the displayed User and/or ValidationTimestamp cannot be fully shown due to limited space in the editor field, the complete information can be accessed via a Popup.
To show the Popup displaying the full User and ValidationTimestamp without truncation, click on the editor field.

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

==== Picture Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICTURE_TASK|picture task]] is a check task which can only be finished when it has at least one child document containing a valid file. In the UI, an additional photo button is presented next to the check so users can easily take photos before finishing the tasks.
* As any other objects, picture tasks can carry and display [[SYSCLS_CHILDINFOOWNER|child count information]]. But that is not a mandatory part of the feature. Even when it's not configured and not visible in the UI, you can still finish the tasks.
* In WinX/UWP, the UI also presents an expander which allows you to display the child documents of picture tasks. This is not present by default in the Mobile app due to the screen size limit but [[Object_hierarchy_in_XAML:_NextLevel,_ParentLevel,_LinkedLevel#Show_NextLevel_Children.2FDocuments|can be easily customized]].

{{Hint|The task is named as such because pictures are the most commonly used types, but the child documents can be of other types as well. }}

When a user tries to finish a picture task by tapping the check, the app might perform some data synchronization first if in online mode, which includes
* Syncing the child objects (including documents) of the task.
* Downloading the file(s) of the child documents.
During data synchronization, the check button on that task turns into a wait indicator. Afterwards, the app checks if the prerequisites to finish the task are met.
* If there are no child documents or no local files for the child documents, the task remains unfinished and the user gets informed about the reasons.
* Otherwise, the task gets finished and the photo button gets disabled.

{{Hint|Setting NA (not applicable) on a picture task is always possible, regardless of the condition of child documents.}}

==== Numeric Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_MRO_NUMERIC_TASK|numeric task]] is a task which records a double value (e.g. from a temperature sensor). Entering the value (including Not Applicable) completes the task.
* The value is compared against an accaptable value range which is not editable on the client.
* Deviation from this range results in visual feedback as well as the [[#Tech Status|tech status]] being set to display an issue.
* If the configured value range is invalid (e.g. min > max) and the user enters a value, the [[#Tech Status|tech status]] will also be set to display an issue.
* A numeric task also has a special value unit that can be set per task instance. If set, it overrides the standard value unit defined on the [[MetaProperty#Unit_Item|MetaProperty]].

==== Pick List Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ====

A [[MROCLS_PICK_LIST_TASK|Pick List task]] looks and behaves the same like a standard Integer Task with SelectiveList. Other than the standard Integer Task, the Pick List Task has an [[UBIK_Active_Lists|Active List]] defined on instance level to pick from for its value property. The task counts as finished as soon as a list item has been selected, or when pressing ''Not Applicable''.

=== MRO objects with project information (WinX only) {{Version/WinXSince|2.5.4}} ===
[[File:UI_WinX_MRO_ProjectInfo.png|thumb|MRO Object with Project Info (WinX)]]
An MRO object (except tasks) might also bring along [[MROCLS_PROJECTINFORMATION|project information]]. In this case, the project information together with the MRO progress are displayed in a bar chart. The start & end dates of the MRO object are displayed on the progress bar. The length and the position of the progress bar, together with the current date mark indicate the timeline.
{{Clear}}

== Locking ==
When an (MRO) object is locked, editing it becomes impossible. More details about [[Locked_Objects|locked objects]].

== See also ==
* [[MRO (Plugin)]]
* [[MROCLS_PROJECT]]
* [[MROCLS_PROJECTINFORMATION]]
* [[MROCLS_SEQUENTIALTASK]]
* [[MROCLS_GROUPEDTASK]]
* [[MROCLS_MRO_CHECK_TASK]]
* [[MROCLS_MRO_INSPECTION_TASK]]
* [[MROCLS_MRO_MEASUREMENT_TASK]]
* [[MROCLS_MRO_PROGRESS_TASK]]
* [[MROCLS_MRO_TASK]]
* [[MROCLS_MRO_TASKOWNER]]
* [[MROCLS_MRO_WORKPACKAGE]]
* [[MROCLS_PROCEDURE#Procedure Workpackage]] (Classification)
* [[MROCLS_SWITCH_TASK#Switch Task]] (Classification)
* [[MROCLS_SWITCH_END_TASK#Switch End Task]] (Classification)
* [[MROCLS_CALCULATION_TASK#Calculation Task]] (Classification)
* [[MROCLS_PICK_LIST_TASK]] (Classification)

[[Category:Android|MRO Objects (UBIK WinX)]]
[[Category:Client|MRO Objects (Client)]]
[[Category:Mobile|MRO Objects (Client)]]
[[Category:Pages with broken file links|MRO Objects (Client)]]
[[Category:WinX|MRO Objects (UBIK WinX)]]

UBIK WinX Client Basics

2026-05-11T09:34:15Z

KGR: /* Properties with value records {{Version/WinXSince|2.5.4}} */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

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

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== 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 and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
==== Saving Indicator ====
[[File:UBIK_SaveIndicator.png|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== Child Page ===

[[File:UBIK_ChildPage.png|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

==== High priority properties ====
High priority properties are properties having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only '''PropertyViewModel.SelectiveItems''', which will return the items of an [[Active_List_Client|ActiveList]], or the items of a MetaProperty.SelectiveList, depending on the server-side configuration. In this case, the [[Converters_In_Mobile#List_of_Available_Converters|SelectiveListToItemsConverter]] is outdated and should not be used anymore.}}

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:ViewEditHistory.png|thumb|Open edit history]]
[[File:PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

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

=== Markerless ===

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

The user can 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 ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA 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.

==== 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_WinX_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#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity 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 propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Properties.AllItems}" />
</Grid>
</source>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

File:ViewEditHistory.png

2026-05-11T09:34:03Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Live Values

2026-05-11T09:11:47Z

KGR: /* Connectivity Indicator */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, thus describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Mobile)
File:UI_WinX_live_values_row_new.png| Reliable live values (Windows)
File:UI_WinX_live_values_detailsrow_new.png| Reliable live values in the document/details view (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:UI_android_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Android)]]
[[File:UI_WinX_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

Live Values

2026-05-11T09:11:17Z

KGR: /* Connectivity Indicator */

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Mobile|Live values in Mobile]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Mobile and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, thus describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:LiveValuesMobile.jpg| Reliable live values (Android)
File:UI_WinX_live_values_row_new.png| Reliable live values (Windows)
File:UI_WinX_live_values_detailsrow_new.png| Reliable live values in the document/details view (Windows)
</gallery>

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

==Map view==
[[File:UI_android_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Android)]]
[[File:UI_WinX_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service {{Version/ServerSince|2.6.4}} Version 2.6.4 and Client Version 3.6.

Since {{Version/ServerSince|4.5.0}} Version 4.5.0 UBIK Live Values support properties being classified as LiveValueAttribute. If they are filled out, the value is sent as LiveValueAttribute to the client with every value update. The Standard Live Value Metaclass provides two Standard (LiveValueAttribute) properties (UI_DESCR and UNIT). It is possible to add more properties if necessary. The Name of the MetaProperty is used as Attribute - Key. In the case of a name conflict the Attribute coming from the Live Value Server is wins against the Attribute coming from the LiveValue.
Following types are supported:
* String
* Multi language String
* Integer
* DateTime
* Double
* GeoData

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

=== Binding to Description ===
Like with a regular property, the description of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Description}"/>
</syntaxhighlight>

{{Hint|It's possible that the description comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UI_DESCR" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

=== Binding to Unit ===
Like with a regular property, the unit of a live value property can be accessed as the following.
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Unit}"/>
</syntaxhighlight>

{{Hint|It's possible that the unit comes not from the property's underlying [[MetaProperty]], but rather from the value of an attribute called "UNIT" (if present).{{Version/WinXSince|4.5}}{{Version/XamarinSince|4.5}}}}

== See also ==
* [[HowTo:Implementing_Live_Values]]
* [[Charts]]

[[Category:2.5.0|Live Values]]
[[Category:Android|Live Values]]
[[Category:Live Values|Live Values]]
[[Category:Mobile|Live Values]]
[[Category:Server|Live Values]]
[[Category:WinX|Live Values]]

File:LiveValuesMobile.jpg

2026-05-11T09:11:09Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

UBIK WinX Client Basics

2026-05-11T08:25:37Z

KGR: /* Properties with value records {{Version/WinXSince|2.5.4}} */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

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

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== 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 and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
==== Saving Indicator ====
[[File:UBIK_SaveIndicator.png|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== Child Page ===

[[File:UBIK_ChildPage.png|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

==== High priority properties ====
High priority properties are properties having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only '''PropertyViewModel.SelectiveItems''', which will return the items of an [[Active_List_Client|ActiveList]], or the items of a MetaProperty.SelectiveList, depending on the server-side configuration. In this case, the [[Converters_In_Mobile#List_of_Available_Converters|SelectiveListToItemsConverter]] is outdated and should not be used anymore.}}

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

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

=== Markerless ===

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

The user can 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 ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA 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.

==== 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_WinX_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#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity 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 propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Properties.AllItems}" />
</Grid>
</source>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

File:PropertyValueRecords.png

2026-05-11T08:25:04Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Login View

2026-05-11T08:01:02Z

KGR: /* Profile selection */

For confidentiality reason, users are required to login before they have access to most of the {{UBIK}} features.

== Accessing login view ==
The login view is displayed after starting the app. It is possible to access the login view from every where in the app by pressing the login icon in the top right corner and selecting "log out".

At the top of the screen, the name of the most recently used profile (if any) will be displayed. When pressing "Login" without selecting a different profile first, this profile will automatically be used.

{{Clear}}

== Profile selection ==
[[File:ProfileBrowser.png|x200px|thumb|alt=Profile Browser|Profile Browser]]
The name of the currently selected profile is displayed on the top of the view. By default, the last used profile will be selected here.
It is possible to change the profile by pressing the Profile Button. The profile selection flyout will pop up, from which the user can select any profile (see the figure on the right).

To add custom profiles, you must add them under the app's RoamingState folder. You can also categorize your profiles using subfolders within this directory.
You will see 2 different tabs when opening the profile selection view, with the third hidden by default.

=== Favorites ===
The "Favorites" tab shows profiles that the user has marked as favorites. To mark a profile as favorite, simply click the the star icon next to a profile's name. You will see it immediately appearing in the favorites list (sorted alphabetically). You can of course undo this action by simply pressing the star icon again to unmark the profile as favorite.

=== Recent ===
The "Recent" tab shows all available profiles, ordered by most recently used (at the top), to least recently used, excluding favorited profiles (which appear in the "Favorites" tab). When you click a profile anywhere in the selection view, it will be timestamped, and added to the top of the "Recent" tab.

=== Browser ===
To view the "Browser" tab, the user can click the expansion button on the right side to toggle the tab open or closed.
The "Browser" tab shows all available profiles (including favorites), but displays them exactly as your file browser would, including sub folders. The user can navigate through sub folders simply by clicking them.

{{Clear}}

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

== Login ==

=== UWP older versions ===
[[File:UI_WinX_Login_Dialog.png|thumb|alt=Login Dialog|Login Dialog]]
The login dialog is opened by pressing the Login button. The dialog also opens automatically after selecting a profile.
The first time the user uses a single profile to connect to a service, he is asked whether the system should remember login and password (for the user and profile). If the user selects yes, the login dialog will not appear again and the credentials are used immediately the next time he connects by using the profile. If the user selects no, he has to enter his credentials every time.

=== UWP{{Version/WinXSince|3.6}} & Mobile clients ===
<gallery widths="350" heights="300">
File:LoginView_WinX.png|UBIK UWP{{Version/WinXSince|3.6}}
File:LoginViewUBIKGO.jpg|UBIK Mobile
</gallery>
{{UBIK}} can remember multiple users per profile. By default, the last remembered one for the selected profile is used. And as you type in a different username, {{UBIK}} constantly checks whether it is a remembered user. If so, the password is automatically filled so that you don't have to.
* A user can only be remembered after a successful online login, namely the username and password must be authenticated at least once by the server;
* If a new password is entered for a remembered user and it is authenticated by the server, the remembered one will be updated;
* By unchecking the remembering option and logging in, the remembered user will be "forgotten". This is also possible without a server authentication. Afterwards, offline login is still possible for this user.

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

=== Offline Login ===
Every successful online login is stored. The stored credentials are used for supporting offline logins.
{{Hint|You can access a local database without online connection (offline) when the credentials were used once to connect successfully to the online service.}}

=== Clear Cache ===
The clear cache feature (settings) deletes all the remembered credentials (login and password) from the system.
{{Attention|Offline logins are not possible after clearing the cache until the user connected once at the online service.}}

== Team login {{Version/WinXSince|2.6.1}} ==
{{Attention|This feature is now obselete.}}

[[File:UI_WinX_Team_Login_Button.png|thumb|alt=Team Login Button|Team Login Button]]
[[File:UI_WinX_Team_Login_Dialog.png|thumb|alt=Team Login Dialog|Team Login Dialog]]
Team login allows a group of users to login with a single device and perform tasks together as a team.

=== Team login button ===
{{Attention|This button is not available by default in the app, certain custom templates are needed for this. An example template can be downloaded {{FileLink|xaml_262_20170310_Team_Login_Button.zip|here}}.}}

=== Team login dialog ===
The team login dialog has the following parts:
# Profile selector to change profiles;
#Team member list (each member has a remove button at the right side);
# {{key press|+}} button to add members;
# {{key press|Login}} button;
# {{key press|Close}} button.
The same [[Login_View#Login_Dialog|login dialog]] shows up once the {{key press|+}} button is pressed and the members should enter their credentials one by one. Once all the members are successfully added, press the {{key press|Login}} button to login as a team.
{{Hint|All members in a team should login to the same service, namely using the same profile. Therefore, the profile selector will be disabled as long as the member list is not empty.}}

== Login details ==

{{Version/WinXSince|3.8}}{{Version/XamarinSince|1.2}}, it's possible for the client to receive login details of the current user as well as other users.
Currently, that information is not displayed in the default UI. However, it's accessible under the globally available AppStatus through XAML customizing.
* AppStatus.CurrentLogin: The current login instance;
* AppStatus.AllLogins: All available login instances;
* AppStatus.UpdateLoginDetailsCommand.
It is recommended to use the [[Developer_Mode#Browsing_the_ViewModel.2FContext|developer mode]] to inspect what can be expected from each of these.

Technically speaking, the full login details come from the two following sources.

=== Current login ===
The client contacts the web service for the basic information of the currently logged-in user when switched to non-offline sync modes.
* UID: uniquely identifies the login/user;
* LoginName: name of the login/user;
* Image: user icon or profile image;
* DisplayStrings: descriptive texts.
This information is persisted in the database, therefore, also available offline as long as you have logged in online once.

=== Login instances ===
[[SYSCLS_LOGIN|Login instances]] can be delivered just as any {{UBIK}} content to the client. They can carry any amount of information which is accessible through RawDetails - a key value dictionary.

{{Hint|If available, the instance matching the current login's UID will be used to extend the available login details. It's possible to have duplicate information in the current login, e.g. LoginName available from direct web service communication as well as the same named property through RawDetails. In such a case, it's recommended to take the former over the latter.}}

== Commands ==

=== Login related ===
Three commands are available for logging in/out.
* LogoutCommand;
* LoginCommand;
* ToggleLoginCommand: Log out if you are already logged in, log in otherwise.

<tabs>
LoginCommand and ToggleLoginCommand support an additional command parameter to automatically navigate to the root page after a successful login.
The parameter can be both a simple boolean value, or a KeyValueList with a boolean value under the key of "NavigateToRootPageOnLogin". See examples below.
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

File:ProfileBrowser.png

2026-05-11T08:00:45Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Login View

2026-05-11T07:57:52Z

KGR: /* UWP{{Version/WinXSince|3.6}} & Mobile clients */

For confidentiality reason, users are required to login before they have access to most of the {{UBIK}} features.

== Accessing login view ==
The login view is displayed after starting the app. It is possible to access the login view from every where in the app by pressing the login icon in the top right corner and selecting "log out".

At the top of the screen, the name of the most recently used profile (if any) will be displayed. When pressing "Login" without selecting a different profile first, this profile will automatically be used.

{{Clear}}

== Profile selection ==
[[File:Profile_browser.png|x200px|thumb|alt=Profile Browser (collapsed)|Profile Browser (collapsed)]] [[File:Profile_browser_expanded.png|x200px|thumb|alt=Profile Browser (expanded)|Profile Browser (expanded)]]
The name of the currently selected profile is displayed on the top of the view. By default, the last used profile will be selected here.
It is possible to change the profile by pressing the Profile Button. The profile selection flyout will pop up, from which the user can select any profile (see the figure on the right).

To add custom profiles, you must add them under the app's RoamingState folder. You can also categorize your profiles using subfolders within this directory.
You will see 2 different tabs when opening the profile selection view, with the third hidden by default.

=== Favorites ===
The "Favorites" tab shows profiles that the user has marked as favorites. To mark a profile as favorite, simply click the the star icon next to a profile's name. You will see it immediately appearing in the favorites list (sorted alphabetically). You can of course undo this action by simply pressing the star icon again to unmark the profile as favorite.

=== Recent ===
The "Recent" tab shows all available profiles, ordered by most recently used (at the top), to least recently used, excluding favorited profiles (which appear in the "Favorites" tab). When you click a profile anywhere in the selection view, it will be timestamped, and added to the top of the "Recent" tab.

=== Browser ===
To view the "Browser" tab, the user can click the expansion button on the right side to toggle the tab open or closed.
The "Browser" tab shows all available profiles (including favorites), but displays them exactly as your file browser would, including sub folders. The user can navigate through sub folders simply by clicking them.

{{Clear}}

== Login ==

=== UWP older versions ===
[[File:UI_WinX_Login_Dialog.png|thumb|alt=Login Dialog|Login Dialog]]
The login dialog is opened by pressing the Login button. The dialog also opens automatically after selecting a profile.
The first time the user uses a single profile to connect to a service, he is asked whether the system should remember login and password (for the user and profile). If the user selects yes, the login dialog will not appear again and the credentials are used immediately the next time he connects by using the profile. If the user selects no, he has to enter his credentials every time.

=== UWP{{Version/WinXSince|3.6}} & Mobile clients ===
<gallery widths="350" heights="300">
File:LoginView_WinX.png|UBIK UWP{{Version/WinXSince|3.6}}
File:LoginViewUBIKGO.jpg|UBIK Mobile
</gallery>
{{UBIK}} can remember multiple users per profile. By default, the last remembered one for the selected profile is used. And as you type in a different username, {{UBIK}} constantly checks whether it is a remembered user. If so, the password is automatically filled so that you don't have to.
* A user can only be remembered after a successful online login, namely the username and password must be authenticated at least once by the server;
* If a new password is entered for a remembered user and it is authenticated by the server, the remembered one will be updated;
* By unchecking the remembering option and logging in, the remembered user will be "forgotten". This is also possible without a server authentication. Afterwards, offline login is still possible for this user.

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

=== Offline Login ===
Every successful online login is stored. The stored credentials are used for supporting offline logins.
{{Hint|You can access a local database without online connection (offline) when the credentials were used once to connect successfully to the online service.}}

=== Clear Cache ===
The clear cache feature (settings) deletes all the remembered credentials (login and password) from the system.
{{Attention|Offline logins are not possible after clearing the cache until the user connected once at the online service.}}

== Team login {{Version/WinXSince|2.6.1}} ==
{{Attention|This feature is now obselete.}}

[[File:UI_WinX_Team_Login_Button.png|thumb|alt=Team Login Button|Team Login Button]]
[[File:UI_WinX_Team_Login_Dialog.png|thumb|alt=Team Login Dialog|Team Login Dialog]]
Team login allows a group of users to login with a single device and perform tasks together as a team.

=== Team login button ===
{{Attention|This button is not available by default in the app, certain custom templates are needed for this. An example template can be downloaded {{FileLink|xaml_262_20170310_Team_Login_Button.zip|here}}.}}

=== Team login dialog ===
The team login dialog has the following parts:
# Profile selector to change profiles;
#Team member list (each member has a remove button at the right side);
# {{key press|+}} button to add members;
# {{key press|Login}} button;
# {{key press|Close}} button.
The same [[Login_View#Login_Dialog|login dialog]] shows up once the {{key press|+}} button is pressed and the members should enter their credentials one by one. Once all the members are successfully added, press the {{key press|Login}} button to login as a team.
{{Hint|All members in a team should login to the same service, namely using the same profile. Therefore, the profile selector will be disabled as long as the member list is not empty.}}

== Login details ==

{{Version/WinXSince|3.8}}{{Version/XamarinSince|1.2}}, it's possible for the client to receive login details of the current user as well as other users.
Currently, that information is not displayed in the default UI. However, it's accessible under the globally available AppStatus through XAML customizing.
* AppStatus.CurrentLogin: The current login instance;
* AppStatus.AllLogins: All available login instances;
* AppStatus.UpdateLoginDetailsCommand.
It is recommended to use the [[Developer_Mode#Browsing_the_ViewModel.2FContext|developer mode]] to inspect what can be expected from each of these.

Technically speaking, the full login details come from the two following sources.

=== Current login ===
The client contacts the web service for the basic information of the currently logged-in user when switched to non-offline sync modes.
* UID: uniquely identifies the login/user;
* LoginName: name of the login/user;
* Image: user icon or profile image;
* DisplayStrings: descriptive texts.
This information is persisted in the database, therefore, also available offline as long as you have logged in online once.

=== Login instances ===
[[SYSCLS_LOGIN|Login instances]] can be delivered just as any {{UBIK}} content to the client. They can carry any amount of information which is accessible through RawDetails - a key value dictionary.

{{Hint|If available, the instance matching the current login's UID will be used to extend the available login details. It's possible to have duplicate information in the current login, e.g. LoginName available from direct web service communication as well as the same named property through RawDetails. In such a case, it's recommended to take the former over the latter.}}

== Commands ==

=== Login related ===
Three commands are available for logging in/out.
* LogoutCommand;
* LoginCommand;
* ToggleLoginCommand: Log out if you are already logged in, log in otherwise.

<tabs>
LoginCommand and ToggleLoginCommand support an additional command parameter to automatically navigate to the root page after a successful login.
The parameter can be both a simple boolean value, or a KeyValueList with a boolean value under the key of "NavigateToRootPageOnLogin". See examples below.
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

Login View

2026-05-11T07:57:09Z

KGR: /* UWP{{Version/WinXSince|3.6}} & Mobile clients */

For confidentiality reason, users are required to login before they have access to most of the {{UBIK}} features.

== Accessing login view ==
The login view is displayed after starting the app. It is possible to access the login view from every where in the app by pressing the login icon in the top right corner and selecting "log out".

At the top of the screen, the name of the most recently used profile (if any) will be displayed. When pressing "Login" without selecting a different profile first, this profile will automatically be used.

{{Clear}}

== Profile selection ==
[[File:Profile_browser.png|x200px|thumb|alt=Profile Browser (collapsed)|Profile Browser (collapsed)]] [[File:Profile_browser_expanded.png|x200px|thumb|alt=Profile Browser (expanded)|Profile Browser (expanded)]]
The name of the currently selected profile is displayed on the top of the view. By default, the last used profile will be selected here.
It is possible to change the profile by pressing the Profile Button. The profile selection flyout will pop up, from which the user can select any profile (see the figure on the right).

To add custom profiles, you must add them under the app's RoamingState folder. You can also categorize your profiles using subfolders within this directory.
You will see 2 different tabs when opening the profile selection view, with the third hidden by default.

=== Favorites ===
The "Favorites" tab shows profiles that the user has marked as favorites. To mark a profile as favorite, simply click the the star icon next to a profile's name. You will see it immediately appearing in the favorites list (sorted alphabetically). You can of course undo this action by simply pressing the star icon again to unmark the profile as favorite.

=== Recent ===
The "Recent" tab shows all available profiles, ordered by most recently used (at the top), to least recently used, excluding favorited profiles (which appear in the "Favorites" tab). When you click a profile anywhere in the selection view, it will be timestamped, and added to the top of the "Recent" tab.

=== Browser ===
To view the "Browser" tab, the user can click the expansion button on the right side to toggle the tab open or closed.
The "Browser" tab shows all available profiles (including favorites), but displays them exactly as your file browser would, including sub folders. The user can navigate through sub folders simply by clicking them.

{{Clear}}

== Login ==

=== UWP older versions ===
[[File:UI_WinX_Login_Dialog.png|thumb|alt=Login Dialog|Login Dialog]]
The login dialog is opened by pressing the Login button. The dialog also opens automatically after selecting a profile.
The first time the user uses a single profile to connect to a service, he is asked whether the system should remember login and password (for the user and profile). If the user selects yes, the login dialog will not appear again and the credentials are used immediately the next time he connects by using the profile. If the user selects no, he has to enter his credentials every time.

=== UWP{{Version/WinXSince|3.6}} & Mobile clients ===
<gallery widths="260" heights="300">
File:LoginView_WinX.png|UBIK UWP{{Version/WinXSince|3.6}}
File:LoginViewUBIKGO.jpg|UBIK Mobile
</gallery>
{{UBIK}} can remember multiple users per profile. By default, the last remembered one for the selected profile is used. And as you type in a different username, {{UBIK}} constantly checks whether it is a remembered user. If so, the password is automatically filled so that you don't have to.
* A user can only be remembered after a successful online login, namely the username and password must be authenticated at least once by the server;
* If a new password is entered for a remembered user and it is authenticated by the server, the remembered one will be updated;
* By unchecking the remembering option and logging in, the remembered user will be "forgotten". This is also possible without a server authentication. Afterwards, offline login is still possible for this user.

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

=== Offline Login ===
Every successful online login is stored. The stored credentials are used for supporting offline logins.
{{Hint|You can access a local database without online connection (offline) when the credentials were used once to connect successfully to the online service.}}

=== Clear Cache ===
The clear cache feature (settings) deletes all the remembered credentials (login and password) from the system.
{{Attention|Offline logins are not possible after clearing the cache until the user connected once at the online service.}}

== Team login {{Version/WinXSince|2.6.1}} ==
{{Attention|This feature is now obselete.}}

[[File:UI_WinX_Team_Login_Button.png|thumb|alt=Team Login Button|Team Login Button]]
[[File:UI_WinX_Team_Login_Dialog.png|thumb|alt=Team Login Dialog|Team Login Dialog]]
Team login allows a group of users to login with a single device and perform tasks together as a team.

=== Team login button ===
{{Attention|This button is not available by default in the app, certain custom templates are needed for this. An example template can be downloaded {{FileLink|xaml_262_20170310_Team_Login_Button.zip|here}}.}}

=== Team login dialog ===
The team login dialog has the following parts:
# Profile selector to change profiles;
#Team member list (each member has a remove button at the right side);
# {{key press|+}} button to add members;
# {{key press|Login}} button;
# {{key press|Close}} button.
The same [[Login_View#Login_Dialog|login dialog]] shows up once the {{key press|+}} button is pressed and the members should enter their credentials one by one. Once all the members are successfully added, press the {{key press|Login}} button to login as a team.
{{Hint|All members in a team should login to the same service, namely using the same profile. Therefore, the profile selector will be disabled as long as the member list is not empty.}}

== Login details ==

{{Version/WinXSince|3.8}}{{Version/XamarinSince|1.2}}, it's possible for the client to receive login details of the current user as well as other users.
Currently, that information is not displayed in the default UI. However, it's accessible under the globally available AppStatus through XAML customizing.
* AppStatus.CurrentLogin: The current login instance;
* AppStatus.AllLogins: All available login instances;
* AppStatus.UpdateLoginDetailsCommand.
It is recommended to use the [[Developer_Mode#Browsing_the_ViewModel.2FContext|developer mode]] to inspect what can be expected from each of these.

Technically speaking, the full login details come from the two following sources.

=== Current login ===
The client contacts the web service for the basic information of the currently logged-in user when switched to non-offline sync modes.
* UID: uniquely identifies the login/user;
* LoginName: name of the login/user;
* Image: user icon or profile image;
* DisplayStrings: descriptive texts.
This information is persisted in the database, therefore, also available offline as long as you have logged in online once.

=== Login instances ===
[[SYSCLS_LOGIN|Login instances]] can be delivered just as any {{UBIK}} content to the client. They can carry any amount of information which is accessible through RawDetails - a key value dictionary.

{{Hint|If available, the instance matching the current login's UID will be used to extend the available login details. It's possible to have duplicate information in the current login, e.g. LoginName available from direct web service communication as well as the same named property through RawDetails. In such a case, it's recommended to take the former over the latter.}}

== Commands ==

=== Login related ===
Three commands are available for logging in/out.
* LogoutCommand;
* LoginCommand;
* ToggleLoginCommand: Log out if you are already logged in, log in otherwise.

<tabs>
LoginCommand and ToggleLoginCommand support an additional command parameter to automatically navigate to the root page after a successful login.
The parameter can be both a simple boolean value, or a KeyValueList with a boolean value under the key of "NavigateToRootPageOnLogin". See examples below.
<tab name="UWP">
<source lang = "xml">
xmlns:controls="using:UBIK.WinX.Controls"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
<Button...
Command="{Binding LoginCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="NavigateToRootPageOnLogin" Value="true" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

[[Category:Client|Login View]]
[[Category:Mobile|Login View]]
[[Category:WinX|Login View]]

File:LoginViewUBIKGO.jpg

2026-05-11T07:56:16Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

File:LoginView WinX.png

2026-05-11T07:56:15Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Offline Query

2026-05-11T07:51:15Z

KGR: /* String criterion */

Compared to [[QUERY|online / server side queries]], offline queries provide a similar capability to query for objects that match the criteria defined by the query objects. The major differences are:
* The querying happens entirely offline without the need of networks;
* Only objects already available on the client can be found as query results.

{{Hint|The [[SYSCLS_OFFLINE_QUERY|offline query classification]] is primarily needed on the Scope of the offline query, rather than on the MetaClass itself, because the client evaluates the classification.}}

== Offline query page ==
[[File:Offline_Query.png|500px|Offline Query]]
<br>
An offline query page looks similar to a regular content page which shows the properties on the left side and the content objects on the right. The unique characteristics of a query page are:
* The properties on the left serve as query criteria;
* The content objects on the right are the evaluated results of the query;
* There is an additional {{key press|Evaluate}} button in the bottom-left corner;
Users can change the query criteria by editing the property values. A press on the {{key press|Evaluate}} button then will re-evaluate the query and show the results on the right side.

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]

== Offline query criteria ==
An offline query criterion is essentially a property on the query object. When evaluating a query, every criterion/property is checked against all result candidates (See [[#Technical_background|technical background]]). A candidate is a match if
* it has all the same properties as the offline query;
{{Attention|This is changed in newer versions {{Version/WinXSince|3.6}}. A not found property is just ignored.}}
* and the values of these properties indicate they are relevant according to the query criteria. (Some types have different ways to interpret what makes a value relevant. See below.)
{{Hint|The value checking of a criterion is ignored during query evaluations under any of the following circumstances.
* The criterion does not have any value specified;
* The criterion type is not supported/unknown. (See below)}}

Several types of criteria are supported on offline queries.
{| class="wikitable" | width = "50%"
|-
! !! Boolean !! String !! Integer !! Double !! DateTime !! Guid
|- align="center"
| Single Value || ✓ || ✓ || ✓ || ✓ || ✓ || ✓
|- align="center"
| Value Range || || || ✓ || ✓ || ✓ ||
|}

{{Attention|Only those criteria/properties for which the MetaProperty.IndexCount is greater than 0 support value ranges.}}

=== Single value criterion ===
For most single value criteria, {{UBIK}} considers a candidate as a match if the value of the target property equals the value specified in the criterion.
{{Hint|It is possible to use a single DateTime value in a query criterion. However, since even the smallest differences (in seconds or even milliseconds) matter during an equality check, you might want to consider specifying a range instead.}}

=== String criterion ===
For string criteria, instead of checking for the equality, {{UBIK}} does the following.
* Split the string value defined in a criterion by spaces ({{Code| }}) if possible;
<tabs>
<tab name="Since version 3.5">
* {{Version/WinXSince|3.5}} All of these sub strings must be a part of the string value of the target property in order for the candidate to be a match.
For example, candidate object with a name {{Code|PU112 PD112}} is considered as a match under a name criterion with the value {{Code|PU PD}}, but {{Code|PU112}} is not.
</tab>
<tab name="Older versions">
* As long as at least one of the sub strings is a part of the string value of the target property, the candidate is a match.
For example, candidate objects with names {{Code|PU112}} and {{Code|PD2115}} are both considered as matches under a name criterion with the value {{Code|PU PD}}.
</tab>
</tabs>

<headertabs />

[[File:RangeValueDouble.png|thumb|Ranged criterion for double]]
[[File:RangeValueDateTime.png|thumb|Ranged criterion for date time]]

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]

=== Value range criterion ===
For types such as numbers or dates, it is sometimes more comfortable to specify ranges for criteria.
* Example 1: Candidate objects with pressure readings {{Code|20}} and {{Code|25}} are both considered as matches under a pressure reading criterion with the value {{Code|20 ⩽ ... ⩽ 25}}.
* Example 2: Candidate objects with start dates {{Code|09-11-2017}} and {{Code|08-12-2017}} are both considered as matches under a start date criterion with the value {{Code|> 08-11-2017}}.

Currently, the following ranges are supported.
* exclusive between (... < value < ...);
* exclusive greater than (value > ...);
* exclusive less than (value < ...);
* inclusive between (... ⩽ value ⩽ ...);
* inclusive greater than (value ⩾ ...);
* inclusive less than (value ⩽ ...);
* in a collection (value is A, B, ... or X, the UI support for this range definition is limited that you can't yet add or remove values in the collection).

== Technical background ==
As mentioned earlier, all offline query criteria are checked against the result candidates. The [[SYSCLS_OFFLINE_QUERY|"METACLASS_IDS"]] property of the query object determines which objects are the candidates.

{{Clear}}

== Query with context filter values {{Version/WinXSince|4.9}}{{Version/XamarinSince|4.9}} ==
In some use cases, {{UBIK}} might automatically extract certain values from the so-called context and use them during offline query filtering. The following cases are two typical examples.
* [[Dynamic_Selective_List_(Client)|Dynamic selective list]].
* [[Data_Replication_(UBIK_Client)#Data_templates|Data template replication]].
{{Hint|These features worked in earlier versions already. However, the technical design differed and it had certain limitations that made it problematic when you try to evaluate the same query with different filter values at the same time. So the basement, namely offline query with context filter values, is redesigned in the new version.}}

The newly designed version has the following characteristics.
* You can now easily distinguish such automatically extracted context filter values from the user entered filter values in the UI.
* Once there is user entered values, the UI makes it obvious that the user values overrule the context values.
* It's also possible to clear/delete/reset all filter values, whether they are from the context or users.

{{Hint|While it's possible to clear the context filter values, they will be automatically applied again if you start the corresponding filtering process from scratch.}}

{{Attention|By design, the context filter values in the [[Dynamic_Selective_List_(Client)|dynamic selective list]] feature are applied as restrictions. So it is not allowed to overrule those values with user inputs.}}

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]

File:RangeValueDouble.png

2026-05-11T07:51:11Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

File:RangeValueDateTime.png

2026-05-11T07:51:10Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Offline Query

2026-05-11T07:45:57Z

KGR: /* Offline query page */

Compared to [[QUERY|online / server side queries]], offline queries provide a similar capability to query for objects that match the criteria defined by the query objects. The major differences are:
* The querying happens entirely offline without the need of networks;
* Only objects already available on the client can be found as query results.

{{Hint|The [[SYSCLS_OFFLINE_QUERY|offline query classification]] is primarily needed on the Scope of the offline query, rather than on the MetaClass itself, because the client evaluates the classification.}}

== Offline query page ==
[[File:Offline_Query.png|500px|Offline Query]]
<br>
An offline query page looks similar to a regular content page which shows the properties on the left side and the content objects on the right. The unique characteristics of a query page are:
* The properties on the left serve as query criteria;
* The content objects on the right are the evaluated results of the query;
* There is an additional {{key press|Evaluate}} button in the bottom-left corner;
Users can change the query criteria by editing the property values. A press on the {{key press|Evaluate}} button then will re-evaluate the query and show the results on the right side.

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]

== Offline query criteria ==
An offline query criterion is essentially a property on the query object. When evaluating a query, every criterion/property is checked against all result candidates (See [[#Technical_background|technical background]]). A candidate is a match if
* it has all the same properties as the offline query;
{{Attention|This is changed in newer versions {{Version/WinXSince|3.6}}. A not found property is just ignored.}}
* and the values of these properties indicate they are relevant according to the query criteria. (Some types have different ways to interpret what makes a value relevant. See below.)
{{Hint|The value checking of a criterion is ignored during query evaluations under any of the following circumstances.
* The criterion does not have any value specified;
* The criterion type is not supported/unknown. (See below)}}

Several types of criteria are supported on offline queries.
{| class="wikitable" | width = "50%"
|-
! !! Boolean !! String !! Integer !! Double !! DateTime !! Guid
|- align="center"
| Single Value || ✓ || ✓ || ✓ || ✓ || ✓ || ✓
|- align="center"
| Value Range || || || ✓ || ✓ || ✓ ||
|}

{{Attention|Only those criteria/properties for which the MetaProperty.IndexCount is greater than 0 support value ranges.}}

=== Single value criterion ===
For most single value criteria, {{UBIK}} considers a candidate as a match if the value of the target property equals the value specified in the criterion.
{{Hint|It is possible to use a single DateTime value in a query criterion. However, since even the smallest differences (in seconds or even milliseconds) matter during an equality check, you might want to consider specifying a range instead.}}

=== String criterion ===
For string criteria, instead of checking for the equality, {{UBIK}} does the following.
* Split the string value defined in a criterion by spaces ({{Code| }}) if possible;
<tabs>
<tab name="Since version 3.5">
* {{Version/WinXSince|3.5}} All of these sub strings must be a part of the string value of the target property in order for the candidate to be a match.
For example, candidate object with a name {{Code|PU112 PD112}} is considered as a match under a name criterion with the value {{Code|PU PD}}, but {{Code|PU112}} is not.
</tab>
<tab name="Older versions">
* As long as at least one of the sub strings is a part of the string value of the target property, the candidate is a match.
For example, candidate objects with names {{Code|PU112}} and {{Code|PD2115}} are both considered as matches under a name criterion with the value {{Code|PU PD}}.
</tab>
</tabs>

<headertabs />

[[File:UBIK_WinX_UI_Offline_Query_Ranged_Double_Criterion.gif|thumb|Ranged criterion for double]]
[[File:UBIK_WinX_UI_Offline_Query_Ranged_DateTime_Criterion.gif|thumb|Ranged criterion for date time]]
=== Value range criterion ===
For types such as numbers or dates, it is sometimes more comfortable to specify ranges for criteria.
* Example 1: Candidate objects with pressure readings {{Code|20}} and {{Code|25}} are both considered as matches under a pressure reading criterion with the value {{Code|20 ⩽ ... ⩽ 25}}.
* Example 2: Candidate objects with start dates {{Code|09-11-2017}} and {{Code|08-12-2017}} are both considered as matches under a start date criterion with the value {{Code|> 08-11-2017}}.

Currently, the following ranges are supported.
* exclusive between (... < value < ...);
* exclusive greater than (value > ...);
* exclusive less than (value < ...);
* inclusive between (... ⩽ value ⩽ ...);
* inclusive greater than (value ⩾ ...);
* inclusive less than (value ⩽ ...);
* in a collection (value is A, B, ... or X, the UI support for this range definition is limited that you can't yet add or remove values in the collection).

== Technical background ==
As mentioned earlier, all offline query criteria are checked against the result candidates. The [[SYSCLS_OFFLINE_QUERY|"METACLASS_IDS"]] property of the query object determines which objects are the candidates.

{{Clear}}

== Query with context filter values {{Version/WinXSince|4.9}}{{Version/XamarinSince|4.9}} ==
In some use cases, {{UBIK}} might automatically extract certain values from the so-called context and use them during offline query filtering. The following cases are two typical examples.
* [[Dynamic_Selective_List_(Client)|Dynamic selective list]].
* [[Data_Replication_(UBIK_Client)#Data_templates|Data template replication]].
{{Hint|These features worked in earlier versions already. However, the technical design differed and it had certain limitations that made it problematic when you try to evaluate the same query with different filter values at the same time. So the basement, namely offline query with context filter values, is redesigned in the new version.}}

The newly designed version has the following characteristics.
* You can now easily distinguish such automatically extracted context filter values from the user entered filter values in the UI.
* Once there is user entered values, the UI makes it obvious that the user values overrule the context values.
* It's also possible to clear/delete/reset all filter values, whether they are from the context or users.

{{Hint|While it's possible to clear the context filter values, they will be automatically applied again if you start the corresponding filtering process from scratch.}}

{{Attention|By design, the context filter values in the [[Dynamic_Selective_List_(Client)|dynamic selective list]] feature are applied as restrictions. So it is not allowed to overrule those values with user inputs.}}

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]

Offline Query

2026-05-11T07:45:12Z

KGR: /* Offline query page */

Compared to [[QUERY|online / server side queries]], offline queries provide a similar capability to query for objects that match the criteria defined by the query objects. The major differences are:
* The querying happens entirely offline without the need of networks;
* Only objects already available on the client can be found as query results.

{{Hint|The [[SYSCLS_OFFLINE_QUERY|offline query classification]] is primarily needed on the Scope of the offline query, rather than on the MetaClass itself, because the client evaluates the classification.}}

== Offline query page ==
[[File:Offline_Query.png|500px|Offline Query]]
An offline query page looks similar to a regular content page which shows the properties on the left side and the content objects on the right. The unique characteristics of a query page are:
* The properties on the left serve as query criteria;
* The content objects on the right are the evaluated results of the query;
* There is an additional {{key press|Evaluate}} button in the bottom-left corner;
Users can change the query criteria by editing the property values. A press on the {{key press|Evaluate}} button then will re-evaluate the query and show the results on the right side.

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]

== Offline query criteria ==
An offline query criterion is essentially a property on the query object. When evaluating a query, every criterion/property is checked against all result candidates (See [[#Technical_background|technical background]]). A candidate is a match if
* it has all the same properties as the offline query;
{{Attention|This is changed in newer versions {{Version/WinXSince|3.6}}. A not found property is just ignored.}}
* and the values of these properties indicate they are relevant according to the query criteria. (Some types have different ways to interpret what makes a value relevant. See below.)
{{Hint|The value checking of a criterion is ignored during query evaluations under any of the following circumstances.
* The criterion does not have any value specified;
* The criterion type is not supported/unknown. (See below)}}

Several types of criteria are supported on offline queries.
{| class="wikitable" | width = "50%"
|-
! !! Boolean !! String !! Integer !! Double !! DateTime !! Guid
|- align="center"
| Single Value || ✓ || ✓ || ✓ || ✓ || ✓ || ✓
|- align="center"
| Value Range || || || ✓ || ✓ || ✓ ||
|}

{{Attention|Only those criteria/properties for which the MetaProperty.IndexCount is greater than 0 support value ranges.}}

=== Single value criterion ===
For most single value criteria, {{UBIK}} considers a candidate as a match if the value of the target property equals the value specified in the criterion.
{{Hint|It is possible to use a single DateTime value in a query criterion. However, since even the smallest differences (in seconds or even milliseconds) matter during an equality check, you might want to consider specifying a range instead.}}

=== String criterion ===
For string criteria, instead of checking for the equality, {{UBIK}} does the following.
* Split the string value defined in a criterion by spaces ({{Code| }}) if possible;
<tabs>
<tab name="Since version 3.5">
* {{Version/WinXSince|3.5}} All of these sub strings must be a part of the string value of the target property in order for the candidate to be a match.
For example, candidate object with a name {{Code|PU112 PD112}} is considered as a match under a name criterion with the value {{Code|PU PD}}, but {{Code|PU112}} is not.
</tab>
<tab name="Older versions">
* As long as at least one of the sub strings is a part of the string value of the target property, the candidate is a match.
For example, candidate objects with names {{Code|PU112}} and {{Code|PD2115}} are both considered as matches under a name criterion with the value {{Code|PU PD}}.
</tab>
</tabs>

<headertabs />

[[File:UBIK_WinX_UI_Offline_Query_Ranged_Double_Criterion.gif|thumb|Ranged criterion for double]]
[[File:UBIK_WinX_UI_Offline_Query_Ranged_DateTime_Criterion.gif|thumb|Ranged criterion for date time]]
=== Value range criterion ===
For types such as numbers or dates, it is sometimes more comfortable to specify ranges for criteria.
* Example 1: Candidate objects with pressure readings {{Code|20}} and {{Code|25}} are both considered as matches under a pressure reading criterion with the value {{Code|20 ⩽ ... ⩽ 25}}.
* Example 2: Candidate objects with start dates {{Code|09-11-2017}} and {{Code|08-12-2017}} are both considered as matches under a start date criterion with the value {{Code|> 08-11-2017}}.

Currently, the following ranges are supported.
* exclusive between (... < value < ...);
* exclusive greater than (value > ...);
* exclusive less than (value < ...);
* inclusive between (... ⩽ value ⩽ ...);
* inclusive greater than (value ⩾ ...);
* inclusive less than (value ⩽ ...);
* in a collection (value is A, B, ... or X, the UI support for this range definition is limited that you can't yet add or remove values in the collection).

== Technical background ==
As mentioned earlier, all offline query criteria are checked against the result candidates. The [[SYSCLS_OFFLINE_QUERY|"METACLASS_IDS"]] property of the query object determines which objects are the candidates.

{{Clear}}

== Query with context filter values {{Version/WinXSince|4.9}}{{Version/XamarinSince|4.9}} ==
In some use cases, {{UBIK}} might automatically extract certain values from the so-called context and use them during offline query filtering. The following cases are two typical examples.
* [[Dynamic_Selective_List_(Client)|Dynamic selective list]].
* [[Data_Replication_(UBIK_Client)#Data_templates|Data template replication]].
{{Hint|These features worked in earlier versions already. However, the technical design differed and it had certain limitations that made it problematic when you try to evaluate the same query with different filter values at the same time. So the basement, namely offline query with context filter values, is redesigned in the new version.}}

The newly designed version has the following characteristics.
* You can now easily distinguish such automatically extracted context filter values from the user entered filter values in the UI.
* Once there is user entered values, the UI makes it obvious that the user values overrule the context values.
* It's also possible to clear/delete/reset all filter values, whether they are from the context or users.

{{Hint|While it's possible to clear the context filter values, they will be automatically applied again if you start the corresponding filtering process from scratch.}}

{{Attention|By design, the context filter values in the [[Dynamic_Selective_List_(Client)|dynamic selective list]] feature are applied as restrictions. So it is not allowed to overrule those values with user inputs.}}

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]

Offline Query

2026-05-11T07:44:27Z

KGR: /* Offline query page */

Compared to [[QUERY|online / server side queries]], offline queries provide a similar capability to query for objects that match the criteria defined by the query objects. The major differences are:
* The querying happens entirely offline without the need of networks;
* Only objects already available on the client can be found as query results.

{{Hint|The [[SYSCLS_OFFLINE_QUERY|offline query classification]] is primarily needed on the Scope of the offline query, rather than on the MetaClass itself, because the client evaluates the classification.}}

== Offline query page ==
[[File:Offline_Query.png|thumb|Offline Query]]
An offline query page looks similar to a regular content page which shows the properties on the left side and the content objects on the right. The unique characteristics of a query page are:
* The properties on the left serve as query criteria;
* The content objects on the right are the evaluated results of the query;
* There is an additional {{key press|Evaluate}} button in the bottom-left corner;
Users can change the query criteria by editing the property values. A press on the {{key press|Evaluate}} button then will re-evaluate the query and show the results on the right side.

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]

== Offline query criteria ==
An offline query criterion is essentially a property on the query object. When evaluating a query, every criterion/property is checked against all result candidates (See [[#Technical_background|technical background]]). A candidate is a match if
* it has all the same properties as the offline query;
{{Attention|This is changed in newer versions {{Version/WinXSince|3.6}}. A not found property is just ignored.}}
* and the values of these properties indicate they are relevant according to the query criteria. (Some types have different ways to interpret what makes a value relevant. See below.)
{{Hint|The value checking of a criterion is ignored during query evaluations under any of the following circumstances.
* The criterion does not have any value specified;
* The criterion type is not supported/unknown. (See below)}}

Several types of criteria are supported on offline queries.
{| class="wikitable" | width = "50%"
|-
! !! Boolean !! String !! Integer !! Double !! DateTime !! Guid
|- align="center"
| Single Value || ✓ || ✓ || ✓ || ✓ || ✓ || ✓
|- align="center"
| Value Range || || || ✓ || ✓ || ✓ ||
|}

{{Attention|Only those criteria/properties for which the MetaProperty.IndexCount is greater than 0 support value ranges.}}

=== Single value criterion ===
For most single value criteria, {{UBIK}} considers a candidate as a match if the value of the target property equals the value specified in the criterion.
{{Hint|It is possible to use a single DateTime value in a query criterion. However, since even the smallest differences (in seconds or even milliseconds) matter during an equality check, you might want to consider specifying a range instead.}}

=== String criterion ===
For string criteria, instead of checking for the equality, {{UBIK}} does the following.
* Split the string value defined in a criterion by spaces ({{Code| }}) if possible;
<tabs>
<tab name="Since version 3.5">
* {{Version/WinXSince|3.5}} All of these sub strings must be a part of the string value of the target property in order for the candidate to be a match.
For example, candidate object with a name {{Code|PU112 PD112}} is considered as a match under a name criterion with the value {{Code|PU PD}}, but {{Code|PU112}} is not.
</tab>
<tab name="Older versions">
* As long as at least one of the sub strings is a part of the string value of the target property, the candidate is a match.
For example, candidate objects with names {{Code|PU112}} and {{Code|PD2115}} are both considered as matches under a name criterion with the value {{Code|PU PD}}.
</tab>
</tabs>

<headertabs />

[[File:UBIK_WinX_UI_Offline_Query_Ranged_Double_Criterion.gif|thumb|Ranged criterion for double]]
[[File:UBIK_WinX_UI_Offline_Query_Ranged_DateTime_Criterion.gif|thumb|Ranged criterion for date time]]
=== Value range criterion ===
For types such as numbers or dates, it is sometimes more comfortable to specify ranges for criteria.
* Example 1: Candidate objects with pressure readings {{Code|20}} and {{Code|25}} are both considered as matches under a pressure reading criterion with the value {{Code|20 ⩽ ... ⩽ 25}}.
* Example 2: Candidate objects with start dates {{Code|09-11-2017}} and {{Code|08-12-2017}} are both considered as matches under a start date criterion with the value {{Code|> 08-11-2017}}.

Currently, the following ranges are supported.
* exclusive between (... < value < ...);
* exclusive greater than (value > ...);
* exclusive less than (value < ...);
* inclusive between (... ⩽ value ⩽ ...);
* inclusive greater than (value ⩾ ...);
* inclusive less than (value ⩽ ...);
* in a collection (value is A, B, ... or X, the UI support for this range definition is limited that you can't yet add or remove values in the collection).

== Technical background ==
As mentioned earlier, all offline query criteria are checked against the result candidates. The [[SYSCLS_OFFLINE_QUERY|"METACLASS_IDS"]] property of the query object determines which objects are the candidates.

{{Clear}}

== Query with context filter values {{Version/WinXSince|4.9}}{{Version/XamarinSince|4.9}} ==
In some use cases, {{UBIK}} might automatically extract certain values from the so-called context and use them during offline query filtering. The following cases are two typical examples.
* [[Dynamic_Selective_List_(Client)|Dynamic selective list]].
* [[Data_Replication_(UBIK_Client)#Data_templates|Data template replication]].
{{Hint|These features worked in earlier versions already. However, the technical design differed and it had certain limitations that made it problematic when you try to evaluate the same query with different filter values at the same time. So the basement, namely offline query with context filter values, is redesigned in the new version.}}

The newly designed version has the following characteristics.
* You can now easily distinguish such automatically extracted context filter values from the user entered filter values in the UI.
* Once there is user entered values, the UI makes it obvious that the user values overrule the context values.
* It's also possible to clear/delete/reset all filter values, whether they are from the context or users.

{{Hint|While it's possible to clear the context filter values, they will be automatically applied again if you start the corresponding filtering process from scratch.}}

{{Attention|By design, the context filter values in the [[Dynamic_Selective_List_(Client)|dynamic selective list]] feature are applied as restrictions. So it is not allowed to overrule those values with user inputs.}}

[[Category:Client|Offline Query (UBIK WinX)]]
[[Category:Pages with broken file links|Offline Query (UBIK WinX)]]
[[Category:Version 3.1|Offline Query (UBIK WinX)]]
[[Category:WinX|Offline Query (UBIK WinX)]]
[[Category:Mobile|Offline Query (UBIK WinX)]]

File:OfflineQuery RangeValue.png

2026-05-11T07:44:13Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

File:Offline Query.png

2026-05-11T07:44:12Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Property Direct Edit (Client)

2026-05-07T12:57:40Z

KGR: /* PropertyViewModel */

== Overview ==
Property direct editing (also known as inline editing) aims to provide a more efficient way for users to edit properties, especially when such tasks are performed frequently.

Generally speaking, direct editing skips the additional dialogs or pages presented in regular editing and allows users to directly interact with the UI displaying properties. For example, a text box type of control can be used to both display the value of a property and accept modifications of the value from the user.

== Supported property types ==
In {{UBIK}}, we provide default templates for some most frequently used property types. However, you can use your own templates, controls, etc. as you like to deal with these property types or even more (as long as you can find suitable UI controls for dealing with these types). Direct editing properties also support [[Min Max Properties]].
<tabs>
<tab name="UWP">
They are accessible as DataTemplates from UBIKThemes.xaml (use the [[Developer_Mode]] to find the default copy) and the syntax in XAML is <code>{StaticResource TEMPLATE_NAME}</code>. Just like other such templates, they can be customized by overriding the DataTemplates with respective keys in UBIKThemes.xaml.
</tab>

<tab name="Mobile(Xamarin)">
They are accessible as DataTemplates from UBIKThemes.xamlx and the syntax in XAML is <code>{DynamicResource TEMPLATE_NAME}</code>. Just like such templates, they can be customized by providing your own DataTemplate resources (with the keys of TEMPLATE_NAME) in UBIKThemes.xamlx.
</tab>
</tabs>

=== For Properties: ===
* String/Text: named as UBIKPropertyDirectItemString.
* Integer: named as UBIKPropertyDirectItemInt.
* Double: named as UBIKPropertyDirectItemDouble.
* Boolean: named as UBIKPropertyDirectItemBool.
* Guid: named as UBIKPropertyDirectItemGuid.
* DateTime: named as UBIKPropertyDirectItemDateTime.
* GeoData: named as UBIKPropertyDirectItemGeoData.
* With selective list items: named as UBIKPropertyDirectItemList.

{{Hint|Due to the limited screen size of most mobile devices, direct editing is not enabled by default in the Mobile clients.}}

=== For MRO-Tasks: ===
* String/Text: named as UBIKTaskPropertyString.
* Integer: named as UBIKTaskPropertyInt.
* Double: named as UBIKTaskPropertyDouble.
* Boolean: named as UBIKTaskPropertyBool.
* Guid: named as UBIKTaskPropertyGuid.
* DateTime: named as UBIKTaskPropertyDateTime.
* GeoData: named as UBIKTaskPropertyGeoData.
* With selective list items: named as UBIKTaskPropertyList.

{{Hint|Due to the limited screen size of most mobile devices, direct editing is not enabled by default for DateTime and GeoData types in the Mobile clients.}}

== PropertyViewModel ==
This is the view model for every single {{UBIK}} property and also the basement for property direct editing (and regular editing alike). For example, a certain named PropertyViewModel (with the name of PROPERTY_NAME) of the context object in a content page is accessible as <code>{Binding Properties.VisibleItems[PROPERTY_NAME]}</code>.

[[File:UBIK_DirectEditing.png|thumb|A test template for direct editing a String property (Mobile)]]
In the example demonstrated in the screenshot where a test template is used to enable direct editing of a String/Text typed property, the following members of the PropertyViewModel are involved.
* '''InEditing''': This is the boolean member indicating whether the PropertyViewModel is currently in edit mode. It can be used to decide whether the UI should display the DisplayValue text or present a text box for user input;
* '''Description''': This is the description of the underlying property/meta property;
* '''ValueItem.PropertyValue''': This is the value of property stored at the PropertyViewModel which can differ from the underlying property value because there can be editing changes not yet confirmed/saved. It can be read from and written to by the text box;
* '''DisplayValue''': This is the textual version of ValueItem.PropertyValue used for displaying when the InEditing is false;
* '''StartDirectEditCommand''': Sets InEditing to true and starts the direct editing session. In the example, this is linked to the tapped event of the entire template area;
* '''ConfirmEditCommand''': Confirms the edit and sets InEditing to false. Even if the property value is not changed, this will give the property a new validation timestamp, technically modifying the property;
<tabs>
Optional command parameter for ConfirmEditCommand: ToValidate - Whether a validation timestamp should be added even if the value is unchanged when confirmed. Defaults to true if unspecified.
<tab name="UWP">
<source lang = "xml">
<Button ...
xmlns:uc="using:UBIK.WinX.Controls"
Command="{Binding ConfirmEditCommand}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="ToValidate" Value="false" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
<Button ...
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding ConfirmEditCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="ToValidate" Value="false" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>
* '''SaveAndCommitCommand''': In addition to confirming the edit, this also saves the changes to the underlying property, saves the owner object and attempts to commit it if the sync mode allows;
* '''ResetCommand''': Resets the underlying property to its last known server state, saves the owner object and attempts to commit it if the sync mode allows;
* '''DeleteValueCommand''': Sets the underlying property's value(s) to null and erases its validation timestamp, saves the owner object and attempts to commit it if the sync mode allows;
<tabs>
Optional command parameter for ResetCommand and DeleteValueCommand: AutoSave - Whether the change(s) to the property and the object should be saved right after the execution of these commands. Defaults to true if unspecified.
<tab name="UWP">
<source lang = "xml">
<Button ...
xmlns:uc="using:UBIK.WinX.Controls"
Command="{Binding DeleteValueCommand}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="AutoSave" Value="false" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Mobile(Xamarin)">
<source lang = "xml">
<Button ...
xmlns:classes="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding DeleteValueCommand}">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="AutoSave" Value="false" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>
* '''DiscardChangeCommand''': Discards all changes made at the PropertyViewModel level that are not yet saved to the underlying property;
* '''CancelEditCommand''': Cancels the current editing session and discards all changes made at the PropertyViewModel level '''in that session''' (different from DiscardChangeCommand).

{{Hint|Once again, you can use the [[Developer_Mode]] to find out more about the PropertyViewModel, like where they are available and how they can be accessed in XAML, or what other members are available underneath, etc.}}

=== ValueItem.PropertyValue or ValueItem.PropertyValueSessionless {{Version/WinXSince|4.4}}{{Version/XamarinSince|4.4}} ===
When it comes to property editing, there's the concept of edit sessions. A property editor always entails a session which starts when the editor is opened and ends when the editor is closed.
However, this could be different in direct editing. For example,
* The standard UI in {{UBIK}} for direct string editing still has sessions. The session starts when you click on the displayed value text and it turns into a text box for value input. It ends when you confirm the input value and the text box turns back into the displayed value text.
* On the other hand, the direct boolean editing is, for example, sessionless. This is because the UI displays a check box the entire time and there's no way to tell the start or the end of a session.

For most value types (e.g. where typing is involved during direct editing), the session concept still applies. '''ValueItem.PropertyValue''' should be used in bindings in such cases. Otherwise, the input values might be lost during editing. In other cases where direct editing is sessionless, '''ValueItem.PropertyValueSessionless''' should be used. Otherwise, the input value will be rejected since the property is technically speaking not in any edit session.

{{Hint|If you are unsure whether '''ValueItem.PropertyValue''' or '''ValueItem.PropertyValueSessionless''' should be used for a certain property type, go with the former. Because most types do have sessions in their direct editing UI. Also, the problem of misusing the former can be seen immediately, namely the editing doesn't work, whereas misusing the latter can lead to more issues that are hard to notice at first.}}

[[Category:Client|Property Direct Edit (Client)]]
[[Category:Mobile|Property Direct Edit (Client)]]
[[Category:Version 4.0|Property Direct Edit (Client)]]
[[Category:WinX|Property Direct Edit (Client)]]

== Relevant types ==
Here are some types created for the purpose of property direct editing.

=== PropertyDirectItemTemplateSelector ===

This is used in a ListView-like control where item templates should be specified, in this case property item templates specifically. It determines the different DataTemplates to be used for direct editing PropertyViewModels according to their property types. For types that have default {{UBIK}} direct editing support, the template names follow the pattern of "UBIKPropertyDirectItemXXX" where XXX is the type name, e.g. String, DateTime, List, etc.

For types that do not come with default direct editing support, the selector uses the "UBIKPropertyItem" template in which editor dialogs are shown instead.

<tabs>
<tab name="UWP">
Namespace <code>xmlns:tpl="using:UBIK.WinX.Templates"</code>
</tab>

<tab name="Mobile(Xamarin)">
Namespace <code>xmlns:resources="clr-namespace:UBIK.CPL.Resources;assembly=UBIK.CPL"</code>
</tab>
</tabs>

=== TaskPropertyTemplateSelector ===

By default, [[MRO_Objects_(Client)#Task|MRO tasks]] have direct editing enabled for their task related properties in the "UBIKTaskItem" template. This template selector determines the different DataTemplates to be used for direct editing PropertyViewModels according to their property types. For types that have default {{UBIK}} direct editing support, the template names follow the pattern of "UBIKTaskPropertyXXX" where XXX is the type name, e.g. String, DateTime, List, etc.

For types that do not come with default direct editing support, the selector uses the "UBIKTaskProperty" template in which editor dialogs are shown instead.

<tabs>
<tab name="UWP">
Namespace <code>xmlns:tpl="using:UBIK.WinX.Templates"</code>
</tab>

<tab name="Mobile(Xamarin)">
Namespace <code>xmlns:resources="clr-namespace:UBIK.CPL.Resources;assembly=UBIK.CPL"</code>
</tab>
</tabs>

=== ComboBoxItemTemplateSelector (UWP only) ===

By default, a ComboBox uses the same template for the selected item (when closed) as well as the drop down items (when opened), which is not always wanted. This template selector allows you to use different templates for these two types of items.

Namespace <code>xmlns:tpl="using:UBIK.WinX.Templates"</code>
<source lang = "xml">
<tpl:ComboBoxItemTemplateSelector x:Key="ComboBoxItemTemplateSelector" DropDownItemTemplate="{StaticResource XXX}" ComboBoxSectionItemTemplate="{StaticResource XXX}" />
</source>
* DropDownItemTemplate: for the dop down items (when opened)
* ComboBoxSectionItemTemplate: for the selected item (when closed)

=== Behaviors and controls ===
<tabs>
<tab name="UWP">
The KeyEventTriggerBehavior is a specialized version of the EventTriggerBehavior in the way that it sets the event to KeyDown by default and allows customizers to define which key (KeyName) should trigger the action(s).
<source lang = "xml">
<TextBox ...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviours="using:UBIK.WinX.Behaviors">
<Interactivity:Interaction.Behaviors>
<behaviours:KeyEventTriggerBehavior KeyName="Enter">
<Core:InvokeCommandAction Command="{Binding ConfirmEditCommand}" />
</behaviours:KeyEventTriggerBehavior>
<behaviours:KeyEventTriggerBehavior KeyName="Escape">
<Core:InvokeCommandAction Command="{Binding CancelEditCommand}" />
</behaviours:KeyEventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</TextBox>
</source>
</tab>

<tab name="Mobile(Xamarin)">
The SelectAllEntry optionally accepts two commands (ReturnCommand & EscapeCommand) to execute when a user inputs the return key {{key press|Enter}} and the escape key {{key press|Esc}} respecitively.
<source lang = "xml">
<Grid xmlns:renderers="clr-namespace:UBIK.CPL.Platform.Renderers;assembly=UBIK.CPL">
<renderers:SelectAllEntry ...
ReturnCommand="{Binding ConfirmEditCommand}"
EscapeCommand="{Binding CancelEditCommand}" />
</Grid>
</source>
</tab>

<tab name="DateTime Control UWP">
The CalendarControl and TimeControl both have an additional Event called "DateTimeChanged" that is called when confirming a value on the flyoutpickers.
<source lang = "xml">
<controls:UBIKCalendarControl DateString="{Binding ValueItem.PropertyValue.Date, Mode=TwoWay}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="DateTimeChanged">
<Core:InvokeCommandAction Command="{Binding PropertyViewModel.SaveAndCommitCommand}" />
</Core:EventTriggerBehavior>
<behaviours:KeyEventTriggerBehavior KeyName="Enter">
<Core:InvokeCommandAction Command="{Binding PropertyViewModel.ConfirmEditCommand}" />
</behaviours:KeyEventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</controls:UBIKCalendarControl>
<controls:UBIKTimeControl TimeString="{Binding ValueItem.PropertyValue.Time, Mode=TwoWay}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="DateTimeChanged">
<Core:InvokeCommandAction Command="{Binding PropertyViewModel.SaveAndCommitCommand}" />
</Core:EventTriggerBehavior>
<behaviours:KeyEventTriggerBehavior KeyName="Enter">
<Core:InvokeCommandAction Command="{Binding PropertyViewModel.ConfirmEditCommand}" />
</behaviours:KeyEventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</controls:UBIKTimeControl>
</source>
</tab>

<tab name="DateTimeControl Mobile(Xamarin)">
The CalendarControl has an additional Event called "DateSelected" that is called when confirming a value on the flyoutpickers. The TimeControl has a similar "TimeSelected" Event (Note that this event may have wrong behaviour on iOS)
<source lang = "xml">
<DatePicker Date="{Binding PropertyViewModel.ValueItem.PropertyValue.Date, Converter={StaticResource StringToDateTimeTypesConverter}">
<DatePicker.Behaviors>
<behaviors:EventToCommandBehavior EventName="DateSelected" Command="{Binding PropertyViewModel.ConfirmEditCommand}"/>
</DatePicker.Behaviors>
</DatePicker>
<ctrls:TimePickerExt Time="{Binding PropertyViewModel.ValueItem.PropertyValue.Time, Converter={StaticResource StringToDateTimeTypesConverter}">
<ctrls:TimePickerExt.Behaviors>
<behaviors:EventToCommandBehavior EventName="TimeSelected" Command="{Binding PropertyViewModel.ConfirmEditCommand}"/>
</ctrls:TimePickerExt.Behaviors>
</ctrls:TimePickerExt>
</source>
</tab>
</tabs>

[[Category:Client|Property Direct Edit (Client)]]
[[Category:Mobile|Property Direct Edit (Client)]]
[[Category:Version 4.0|Property Direct Edit (Client)]]
[[Category:WinX|Property Direct Edit (Client)]]

File:UBIK DirectEditing.png

2026-05-07T12:57:27Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

UBIK WinX Client Basics

2026-05-07T12:25:36Z

KGR: /* Saving Indicator */

{{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 Mobile 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]].

== Languages ==
The standard {{UBIK}} client supports multiple languages listed below. {{Version/WinXSince|4.3}}
* Chinese (Simplified)
* Czech
* English
* German
* Polish
* Portuguese
* Spanish
{{Attention|As we found out, you can only switch to one of the supported languages if it is installed as a system language in the Windows "Preferred languages / Add a language" setting. For example, if you have only English installed when you install {{UBIK}}, you won't be able to switch to any other languages even if you add those later. In that case, you need to make sure your language of choice is installed in Windows first, then update or reinstall {{UBIK}}. This is a Microsoft Store practice and does not apply to clients installed through sideloading, e.g. from our AppCenter.}}

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

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== 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 and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
==== Saving Indicator ====
[[File:UBIK_SaveIndicator.png|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== Uncommitted Changes Indicator ====
{{Version/WinXSince|4.6.0}} When there are uncommitted changes it is indicated by a button in the Status Bar displaying an icon and the number of uncommitted changes. Pressing this button opens a fly out list with all of the objects that have uncommitted changes to them. Pressing one of those list objects navigates directly to the corresponding object. The Uncommitted Changes Indicator button is only shown when there are uncommitted changes otherwise it is not visible. When in online mode all changes should be committed automatically so the Indicator is mainly useful in Manual or Offline Sync Mode.
<br>
{{Version/WinXSince|4.7.0}} Queries are now excluded from uncommitted changes.

=== Child Page ===

[[File:UBIK_ChildPage.png|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description. With the [[SYSCLS_CHILDINFOOWNER|child info owner classification]], one can additionally show the number of documents and regular grandchildren to be expected for a child object.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

=== Properties Page ===

On the properties page, one can see a list of all the current object's visible properties, and, given the respective rights, a possibility to edit them.

=== Context Menu ===

For any current object, there is a set of potential context-sensitive actions. These are displayed as buttons in the title bar, with a three-dot overflow menu button aggregating all the actions that wouldn't fit there anymore. There are many potential actions; some of them are only enabled for specifically classified objects, like objects with a geo location. Default actions are refresh, various download options, child object creation, copy/paste, commit/revert changes, geo-related actions, etc.

=== Objects ===

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

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

[[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Task|Tasks]] and [[https://wiki.augmensys.com/index.php?title=MRO_Objects_(Client)#Work_Package|work packages]] are special types of {{UBIK}} objects used for maintenance, repair and overhaul (MRO) use-cases.

==== Query objects ====

Queries are special types of {{UBIK}} objects with dynamic children. The child objects are looked up depending on the query object's criteria, which can be specified the same as property values for regular objects. There are [[QUERY|online queries]] evaluated by the server, and [[https://wiki.augmensys.com/index.php?title=Offline_Query_(UBIK_WinX)|offline queries]] evaluated on the client, thus requiring no internet connection.

==== Safety relevant objects ====

Object classified as [[SYSCLS_SAFETY_RELEVANT_OBJECT|safety relevant]] require the user to accept safety instructions to access the object, which can be required for hazardous MRO tasks, for example.

==== Commissioning objects ====

Similar to and based on MRO objects, commissioning objects are tasks and work packages for the commissioning use-case, e.g., [[SYSCLS_COMMISSIONINGCHECK|commissioning check tasks]].

==== Locked objects ====
In several use-cases, objects can be [[Locked_Objects|locked]] for editing.

=== Properties ===

==== Authentication Properties ====
[[SYSCLS_REQUIRE_AUTHENTICATION|Authentication Properties]] are properties which need a user authentication (through a password field) to be edited.

==== Min max properties ====
See [[Min_Max_Properties]].

==== Live value properties ====
[[Live_Values]] are specific property values extracted from a process control system like OPC-UA or OSIPI.

==== High priority properties ====
High priority properties are properties having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====
For some properties, the user should be able to select from a predefined set of values. Such a predefined set is called a "selective list" in {{UBIK}}.
Furthermore, there are [[Dynamic_Selective_List_(Client)|dynamic selective lists]] that can be filtered or assembled based on dependency property values.

{{Hint|{{Version/WinXSince|5.1.0.0}}{{Version/MobileSince|5.1.0.0}} The ItemsSource binding of related WinX/Mobile controls in Xaml now requires only '''PropertyViewModel.SelectiveItems''', which will return the items of an [[Active_List_Client|ActiveList]], or the items of a MetaProperty.SelectiveList, depending on the server-side configuration. In this case, the [[Converters_In_Mobile#List_of_Available_Converters|SelectiveListToItemsConverter]] is outdated and should not be used anymore.}}

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_PropertyWithValueRecords.png|thumb|A property with value records]]
[[File:UI_WinX_PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== [[Editors]] ====

See [[Editors]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).
See [[Documents_(Client)|Documents (Client)]]

==== Fit Mode{{Version/WinXSince|3.5}} ====
See [[Documents_(Client)#Fit_Mode|Fit Mode]]

==== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ====
See [[Documents_(Client)#Auto_zoom|Auto zoom]]

==== Editing{{Version/WinXSince|2.5.4}} ====
See [[Documents_(Client)#Editing|Editing]]

==== Offline availability ====
See [[Documents_(Client)#Offline/Online|Offline/Online]]

==== Clear Online Documents ====
[[Documents_(Client)#Offline/Online|Offline/Online]]

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

=== Markerless ===

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

The user can 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 ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA 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.

==== 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_WinX_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#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity 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 propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Properties.AllItems}" />
</Grid>
</source>

== See also ==
* [[Client_Feature_Table]]
* [[SYSCLS_DOCUMENT_FITMODE]]
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

[[Category:Client|UBIK WinX Client Basics]]
[[Category:How-To|UBIK WinX Client Basics]]
[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]