= UBIK Traits (Client) =

'''UBIK Traits''' provide the ability to define a dynamic list of lightweight properties for individual instances (objects). Unlike traditional UBIK Properties, which are rigidly bound to a MetaClass, instances of the same entity can possess a different list of traits.

This feature is particularly useful for data that only becomes known at runtime or varies significantly from instance to instance.

{{Attention|This feature must be used wisely, too many traits could impact the performance. Traits do not replace properties.}}

== ViewModel Architecture & Data Access ==
To work with traits in the UI (XAML), the <code>ContentViewModel</code> provides several dedicated accessors and collections.

=== 1. ValueAccessors (Recommended for Read/Write) ===
The <code>ValueAccessors</code> acts as a combined dynamic value resolver. It is the '''preferred way''' to read or edit values in the UI because of its built-in fallback logic:
# '''Trait Lookup:''' First attempts to resolve the value via a trait with the specified name.
# '''Property Fallback:''' If no trait is found, it queries a regular UBIK Property with that name.
# '''Default:''' If neither exists, it returns <code>null</code>.

=== 2. TraitByName (Traits Only) ===
A dedicated collection (<code>ObservableTraitDictionary</code>) that exclusively loads and initializes traits. Unlike the <code>ValueAccessors</code>, this does not fall back to regular properties.
* '''Usage:''' When you explicitly want to query ''only'' traits (e.g., read-only display in the UI).

=== 3. Values (Raw Data) ===
This is a combined getter that returns the raw value directly from the dictionary, instead of providing a complex <code>TraitViewModel</code> or <code>PropertyViewModel</code>.
* '''Usage:''' For pure display purposes or evaluations

----

== Commands (Set & Create Values) ==

=== SetValueCommand ===
This command on the <code>ContentViewModel</code> orchestrates value assignments and handles the '''creation of new traits''' if necessary.
* '''If the trait exists:''' The value will be overwritten.
* '''If a property exists:''' The property's value will be overwritten (if it is not locked/read-only).
* '''If neither exists:''' A new <code>TraitViewModel</code> is created and added to the UBIKContent.

----

== Customizing / UI Integration (XAML Examples) ==

To display traits in custom XAML templates, make them editable, or create new ones, standard UBIK controls like <code>EvalExpression</code> or <code>SfListViewExt</code> are used. Here are real-world code examples to guide you:

=== 1. Pure Display of All Traits (List View) ===
If you simply want to display all traits of an object, you can bind directly to <code>Content.Traits</code>. Here, it is combined with the Syncfusion ListView (<code>SfListViewExt</code>):
{{Attention| With that you only bind on DataModel level (changes on viewmodel level are only visible after saving).}}
<syntaxhighlight lang="xml">
<controls:SfListViewExt ItemsSource="{Binding Content.Traits}">
<controls:SfListViewExt.ItemTemplate>
<DataTemplate>
<Border Padding="10,8" BackgroundColor="#FAFAFA" Stroke="#E0E0E0" StrokeShape="RoundRectangle 8">
<Grid ColumnDefinitions="0.4*, 0.6*">
<Label Grid.Column="0" FontAttributes="Bold" Text="{Binding Name}" VerticalTextAlignment="Center" />
<Label Grid.Column="1" Text="{Binding Value, TargetNullValue='Not found'}" TextColor="#555555" VerticalTextAlignment="Center" />
</Grid>
</Border>
</DataTemplate>
</controls:SfListViewExt.ItemTemplate>
</controls:SfListViewExt>
</syntaxhighlight>

=== 2. Edit a Single Trait or Property (via ValueAccessors) ===
To dynamically query and edit a specific trait, use the <code>EvalExpression</code> with the <code>ValueAccessors</code> context. The <code>TwoWay</code> binding ensures that changes are written directly back to the ViewModel.

<syntaxhighlight lang="xml">
<controls:EvalExpression x:Name="EvalS2" Context="{Binding ValueAccessors}" Expression="Context[P0]">
<controls:EvalExpressionParameter Name="P0" Value="{Binding Path=Text, Source={x:Reference S2NameInput}}" />
</controls:EvalExpression>

<Entry x:Name="S2NameInput" Placeholder="Enter name..." />

<Entry x:Name="S2ValueInput" Text="{Binding Result.Value, Source={x:Reference EvalS2}, Mode=TwoWay, FallbackValue='Not found'}" />
</syntaxhighlight>

=== 3. Delete a Trait ===
Deleting a trait does not require a dedicated command. Instead, it uses an event behavior to directly invoke the <code>Delete</code> method on the evaluator's result.

<syntaxhighlight lang="xml">
<Button Text="Delete" BackgroundColor="#D32F2F" TextColor="White">
<Button.Behaviors>
<behaviors:EventHandlerBehavior EventName="Clicked">
<behaviors:InvokeMethodAction TargetObject="{Binding Result, Source={x:Reference EvalS2}}" MethodName="Delete" />
</behaviors:EventHandlerBehavior>
</Button.Behaviors>
</Button>
</syntaxhighlight>

=== 4. Create or Overwrite a Trait (via SetValueCommand) ===
To create traits entirely from scratch (or explicitly overwrite an existing value), the <code>SetValueCommand</code> of the <code>ContentViewModel</code> is used. A <code>KeyValueList</code> must be passed to this command.

<syntaxhighlight lang="xml">
<Grid ColumnDefinitions="*, Auto" ColumnSpacing="10">
<Entry x:Name="S4NameInput" Placeholder="Name of the (new) trait..." />
<Entry x:Name="S4ValueInput" Grid.Column="0" Placeholder="Enter value to set..." />

<Button Grid.Column="1" Command="{Binding SetValueCommand}" Text="Set">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="PropertyName" Value="{Binding Text, Source={x:Reference S4NameInput}}" />
<classes:KeyValueParameter Key="PropertyValue" Value="{Binding Text, Source={x:Reference S4ValueInput}}" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</Grid>
</syntaxhighlight>

=== 5. Edit Specific Datatypes (e.g., DatePicker) ===
Traits store actual underlying datatypes (such as <code>DateTime</code>). This means you can bind regular UI controls like a <code>DatePicker</code> directly to the result of the <code>EvalExpression</code>.

<syntaxhighlight lang="xml">
<controls:EvalExpression x:Name="EvalDateTime" Context="{Binding}" Expression="Context.ValueAccessors[P0]">
<controls:EvalExpressionParameter Name="P0" Value="{Binding Path=Text, Source={x:Reference DateTraitNameInput}}" />
</controls:EvalExpression>

<Entry x:Name="DateTraitNameInput" Text="TRAIT_DATETIME" />

<DatePicker x:Name="DateTestPicker" Date="{Binding Result.Value, Source={x:Reference EvalDateTime}}" Format="dd.MM.yyyy" />

<Button Command="{Binding SetValueCommand}" Text="Set">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="PropertyName" Value="{Binding Text, Source={x:Reference DateTraitNameInput}}" />
<classes:KeyValueParameter Key="PropertyValue" Value="{Binding Date, Source={x:Reference DateTestPicker}}" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</syntaxhighlight>

----

[[Category:Client|Traits]]
[[Category:Mobile|Traits]]
[[Category:MAUI|Traits]]

2026-03-16T08:47:54Z

KGR: /* Viewing/Editing the Object Data */

[[DOCUMENT|Documents]] are [[:Category:UBIK Object|{{UBIK}} objects]] referencing a file, e.g. a PDF document.
Like other {{UBIK}} objects, they can be synchronized to the {{UBIK}} client.
{{UBIK}} supports and displays document objects and a bunch of actions related to them, including e.g. editing, redlining, creation, and thumbnails.

== Document Types ==

* Managed Document - Documents with a locally managed file.
* Linked Document - Documents with a file linked by an URL, not locally managed by {{UBIK}}.

== Viewing Documents ==

Available Documents can be viewed in the documents tab of the current object, they are displayed with a thumbnail preview. <br>

<gallery widths="400" heights="400">
File:DocumentView_WinX.png|WinX
File:DocumentView_MAUI.jpeg|MAUI (iOS)
</gallery>
<br>
On WinX, the display mode for documents can be configured; available display modes are: <br>
* Gallery View (default)
* List View
* Flip View
<br>
[[File:DocumentView_DisplayMode.png]]

<br>Clicking on a document navigates to the corresponding object and opens the internal document viewer.
<gallery widths="400" heights="400">
File:DocumentViewer_WinX.png|WinX
File:DocumentViewer_MAUI.jpeg|Mobile (iOS)
</gallery>

A document can also be viewed by right-clicking on the object's thumbnail. This will open the document in an external editor provided by the operating system.
In this way, the document can also be edited externally. For more details, see [[Documents_(Client)#Editing|Editing]].

=== Viewing or Editing the Object Data ===

Not only the file itself can be viewed, but also the {{UBIK}} property values of a document object. To access them, click on the document object.

The way properties are displayed depends on the client being used.

On the '''WinX''' client, the properties are shown directly on the right side of the screen.

On the '''Mobile''' client, you need to switch to the Properties tab to view them.

<gallery widths="400" heights="400">
File:Properties_WinX.png|WinX
File:Properties_MAUI.jpeg|Mobile (iOS)
</gallery>

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

== Creating Documents ==
Depending on the configuration of the {{UBIK}} data model and the [[ACM]], documents can be created as children for existing objects.
Via the context menu entry you can create such documents. (where it is configured)

{{Attention|File extensions are case-sensitive depending on the OS. On iOS and Android, file systems are case-sensitive, while on Windows, file systems are case-insensitive.}}

=== Taking a Picture ===
In certain cases, the camera can be used to take a picture and create a document for it - in this case, another "Take Picture" context menu entry is available.

=== Editing and Submitting the newly created Document ===
After either a document was chosen or a picture was taken, the newly created object is opened in a property view, allowing the user to abort the creation or to enter specific property values (e.g. for the description of the object) and finally save the object.

{{Version/WinXSince|3.6}} uploaded Document objects can potentially contain [[SYSCLS_FILEDETAILSCLASSIFICATION|detailed Information]] concerning the original file (e.g. file name, path)
{{Clear}}

=== File upload ===
Regarding the file upload, there is a mechanism [[File_Upload_Size_Restriction|FileUploadRestriction]] that ensures files only get uploaded if the file size is below the configured max upload size.

=== Synchronization ===
Depending on the connectivity mode, the next synchronization run will bring the new content and file to the server.

== Modify Documents ==

=== Redlining ===
[[HowTo:Make_a_Document_ready_for_Redlining|Redlining]] is the process of creating a modified or annotated version of an existing document.

To use this feature, click the “Annotation Tools” button in the document viewer toolbar at the top of the document.

After clicking “Annotation Tools”, the toolbar expands and provides several options for annotating the document, such as drawing freeform shapes, adding comments, selecting different colors ...

<gallery widths="400" heights="400">
File:Annotation_WinX.png|WinX
File:Annotation_MAUI.jpeg|Mobile (iOS)
</gallery>

The previous redlining number indicators are replaced by the [[Child_Document_Indicator_(Android)|child document indicators]]. {{Version/AndroidSince|2.4.5}}

=== Editing{{Version/WinXSince|2.5.4}} ===
[[File:Editing_WinX.png|Button to edit a document]]<br>

For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the top app bar. It allows the user to edit a document file using the default app of the OS. If a file is changed during the edit, the same {{key press|save}} button appears just like it does for content with changed properties.
{{Hint|Similar to saving, other app features also apply on edited documents. For example, reverting local changes for an edited document will throw away the changed document file and restore it to the server version.}}
An alternative way to start editing is to right click on a document's thumbnail, which immediately opens the document in an external editor. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).

== Image Editor ==
In {{UBIK}}, images can be edited using the UBIKImageEditor. When you navigate in a image object, the image editor opens automatically. (if configured)

The editor provides several options for modifying the image.

<gallery widths="400" heights="400">
File:ImageEditor_WInX.png|WinX
File:ImageEditor_MAUI.jpeg|Mobile (iOS)
</gallery>

== PDF Documents ==

=== PDF Renderers {{Version/WinXSince|4.6.0}} ===
The Syncfusion PDF control embedded in the WinX client can use two different renderers to render and display PDF documents.
* The standard Syncfusion renderer which uses [https://learn.microsoft.com/en-us/uwp/api/windows.data.pdf?view=winrt-26100 Windows.Data.PDF]
* [https://pdfium.googlesource.com/pdfium/ PDFium]
There can be issues for each renderer when dealing with certain documents. If that's the case, you can try changing the [[Settings#Content|PdfRenderer setting]] in the WinX client and see if the issue still persists.

{{Hint|Generally speaking, the PDFium renderer seems to be more performant in the majority cases. That's why it is the default option.}}

==== Syncfusion ====
When using this renderer, we have experienced an issue with certain PDF diagrams where certain texts change when you zoom in on the documents. Unfortunately, we are unaware of the reason of this issue and could not find public documentation on similar problems.

==== PDFium ====
* This renderer currently does not support digital signatures (e.g. created by [https://www.docusign.com Docusign]) unless they are flattened into the PDF documents.
* With this renderer selected, some documents in the Flip View might appear blank when zooming.

=== PDF Text Search ===
It is possible to search and highlight arbitrary texts in the {{UBIK}} PDF viewer. By clicking the magnifier button, an input field opens to search for specific text entries in the document. The results will be highlighted in the PDF file. By clicking the arrow buttons, it is possible to switch to the next and previous results. {{Version/XamarinSince|4.3.0}}

==== Automatic Text Search {{Version/XamarinSince|4.4.0}}{{Version/WinXSince|4.4.0}} ====
Using the [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION|Document Highlighting Classification]] A PDF document can search for a defined search term from its parents properties automatically as soon as it is being navigated to.

=== Remember Document Settings {{Version/WinXSince|4.9}} ===
By default, PDFViewer settings are not saved and always reset when reloading a document. The Remember Document Settings feature enables the automatic saving & preserving of the Zoom level, Annotation color, and Stroke width value within a {{UBIK}} session.
It can be configured in the [[Settings#Content|Settings]].
With this feature enabled, the PDFViewers Annotation color, Zoom level, and Stroke width value set by the user will be saved and preserved until the user changes them again.

If a document is configured with the [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|Auto Zoom classification]], it will be overruled by the user's value as soon as the user sets it.
If an [[XAML#UBIKPdfViewer|AnnotationDefaultStrokeWidth]] value is configured, it will be overridden by the user's value as soon as the user sets it.

{{Attention|Saving the Zoom value with touch gestures is not supported. But the SaveZoomSettingsCommand can be used to save the Zoom value manually.}}

The SaveZoomSettingsCommand can be applied to a button as follows:
<source lang = "xml">
<pdfViewer:SfPdfViewerControl
Name="pdfViewer"
... />
<Button
Content="Save Zoom"
Command="{Binding ElementName=PdfViewer, Path=SaveZoomSettingsCommand}" />
</source>

=== Fit Mode{{Version/WinXSince|3.5}} ===
By default, documents are displayed in their original dimensions. But administrators can also [[SYSCLS_DOCUMENT_FITMODE|configure different fit modes]] for each document. The following demonstrates how documents can look under different fit modes.

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Unspecified / Unscaled / Default !! Fit to container !! Fit to width !!
|-
| [[File:UI_UWP_Fit_Mode_Default.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Container.png|240x225px]] || [[File:UI_UWP_Fit_Mode_Width.png|240x225px]]
|-
|}

{{Attention|When using a FlipView for documents in your customized XAMLs, you need to additionally [[XAML_Tips#Fit_mode|apply the fit mode]] by yourself. }}
{{Attention|This feature currently only works for PDFs (it is not supported for Images). }}

=== Auto zoom {{Version/WinXSince|4.6}}{{Version/XamarinSince|4.6}} ===
When a PDF document is displayed in UBIK, it's possible that [[SYSCLS_AUTO_ZOOM_CLASSIFICATION|an initial zoom level]] is configured and applied to that document.

{{Attention|The configured initial zoom level will be simply ignored if it's beyond the acceptable min/max zoom levels of the PDF viewer.}}

== Offline/Online ==

=== Offline availability ===
When a user selects a branch to bring offline, files of all document objects underneath are downloaded in principle. However, they can also be selectively configured to be ignored with a [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT|classification]] on the server-side. Once a document is classified as offline available, the document file will not be removed when the storage for already synchronized document files is cleared.
{{Hint|This is not to be confused with the accessibility related to [[User_Rights|user rights]]. The logic here is "some documents '''do not have to''' be downloaded", not "some documents '''can not''' be downloaded/accessed". In other words, a user can browse to and open the document regardless of this configuration.}}

=== Clear Online Documents ===
By clearing the online documents, it is possible to free up system memory if needed. It can be triggered by pressing the button "Clear online documents" in the general settings tab. Online documents are documents already uploaded to the server. They can be downloaded anytime again when the client is connected to the server. However, documents classified as offline available will not be affected and will always stay on the device.

== See also ==
* [[HowTo:Create_a_new_Document_(UBIK_Android)]]
* [[HowTo:Make_a_Document_ready_for_Redlining]]
* [[SYSCLS_DOCUMENT]] (Classification)
* [[SYSCLS_FILEDOCUMENT]] (Classification)
* [[SYSCLS_EDITABLEDOCUMENT]] (Classification)
* [[SYSCLS_REDLINEDFILE]] (Classification)
* [[SYSCLS_DOCUMENT_HIGHLIGHTING_CLASSIFICATION]] (Classification)
* [[SYSCLS_URLDOCUMENT]] (Classification)
* [[SYSCLS_THUMBNAILEDDOCUMENT]] (Classification)
* [[SYSCLS_TEXTDOCUMENT]] (Classification)
* [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT]] (Classification)

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

2026-03-11T10:20:53Z

KGR:

[[File:MRO_WinX.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:|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.

<gallery>
File:UI_WinX_MRO_TechnicalStatusIndicator.png|thumb|Technical Status Indicator (WinX)
File:Android_tech_status.PNG|thumb|Technical Status Indicator (Android)
</gallery>

=== 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:UI_WinX_MRO_OrganisationalStatusIndicator.png|Organisational Status Indicator (WinX)
File:UI_WinX_MRO_WPConfirmedIndicator.png|MRO Workpackage Confirmed (Flag) Indicator (WinX)
File:Android_orga_status.PNG|Organisational Status Indicator (Android)
File:Android_orga_status_finished.PNG|MRO Workpackage Confirmed Indicator (Android)
</gallery>

=== 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:UI_WinX_MRO_WPConfirmButton.png|MRO Workpackage confirm button (WinX)
File:UI_WinX_MRO_WPRevokeConfirmButton.png|MRO Workpackage revoke confirmation button (WinX)
File:Android_finish_workpackage.PNG|MRO Workpackage confirm button (Android)
File:Android reopen workpackage.PNG|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 tooltip.

* In '''UBIK WinX (UWP)''', hover over the editor field with the mouse.
* In '''UBIK Mobile''', perform a long press on the editor field.
A tooltip will appear, displaying the full User and ValidationTimestamp without truncation.

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

{{UnderConstructionStart}}

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

{{UnderConstructionEnd}}

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

[[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-03-11T10:20:06Z

KGR:

File:MRO MAUI.jpeg

2026-03-11T10:19:48Z

KGR: KGR uploaded a new version of File:MRO MAUI.jpeg

File uploaded with MsUpload

File:MRO MAUI.jpeg

2026-03-11T10:13:08Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

File:MRO WinX.png

2026-03-11T10:13:08Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload

Device ID

2026-03-11T09:01:39Z

KGR:

[[File:DeviceID_WinX.png|thumb|350px| Device ID on UWP Client]]
The Device ID is a unique identifier of the device, which is fetched from the OS and used to uniquely identify devices to [[HowTo:Restrict_Access_to_known_Devices_(Satellites) |restrict access]] to them. The type of ID and its origin vary by platform. The Device ID is also sent to the Ubik Web Service.

== Accessing the Device ID ==
Accessing the Device ID is designed to be simple.
=== Android ===
On the legacy Android client, the Device ID can be found on the Information page.
=== UWP ===
On the Windows client, the Device ID can be accessed on the Connection Settings page.
=== Mobile {{Version/XamarinSince|1.1}} ===
On the newer Mobile clients (iOS and Android), the Device ID can be inspected on the General Settings page.

<gallery widths="220" heights="360">
File:DeviceID_MAUI.jpeg| Device ID on Mobile Client
</gallery>

== Technical Information ==
The Device ID should be unique enough to exclusively identify a device/client and shouldn't get lost if the app updates.
=== Windows ===
This information applies both to the UWP/WinX client as well as the unreleased Mobile Widows client:

In the UWP/WinX client until version 3.7.17, the Device ID is created using the [https://docs.microsoft.com/en-us/uwp/api/windows.system.profile.hardwareidentification.getpackagespecifictoken ASHWID identifier] encoded to a Base64 string. This ID is relatively consistent but can change when e.g. a docking station with a network card is attached.

{{Version/WinXSince|3.7.18}}
Starting with UWP 3.7.18, the [https://docs.microsoft.com/en-us/uwp/api/windows.system.profile.systemidentification.getsystemidforpublisher SystemIdentification.GetSystemIdForPublisher()] method is used to return a unique system identifier based on the app publisher ID.
The ID is generated either using a Trusted Platform Module (TPM) if present or a Unified Extensible Firmware Interface (UEFI) if present.
If neither of these sources is available, this method will return an ID that is backed by the Windows registry.
If a system does not have a TPM or UEFI support, and thus an ID was obtained from the registry, a clean install of Windows will result in a new, different ID being returned. If no ID could be generated, the old ASHWID identifier is used.

=== Android ===
On the legacy native Android client, the [https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID ANDROID_ID (SSAID)] is accessed. Before Android 8, this ID was bound to a device for its lifetime. Since Android 8, the ID is different for every user (if the device has the multi-user feature enabled) and when the device is reset.

On the Mobile Android app, before version 1.0.80, depending on the version of the OS, the [https://developer.android.com/reference/android/os/Build#SERIAL Build.SERIAL] is accessed (below Android 8), and [https://developer.android.com/reference/android/os/Build#getSerial() Build.getSerial] starting with Android 8, also requiring the <code>READ_PHONE_STATE</code> permission. With Android 10, the function only works for devices enrolled in an organization.

Version 1.0.80 of the Mobile Android app based the device ID onto the [https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID ANDROID_ID (SSAID)], in the same way to how the native Android client does it. This also removed the need for the <code>READ_PHONE_STATE</code> permission. This method now also works for Android 10+, even for unenrolled devices.

=== iOS ===
On iOS, the application makes use of the [https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor identifierForVendor]. This is a GUID uniquely identifying a device to an app vendor.

[[Category:Android|Device ID]]
[[Category:Device management|Device ID]]
[[Category:Hardware|Device ID]]
[[Category:Mobile|Device ID]]
[[Category:WinX|Device ID]]

File:DeviceID MAUI.jpeg

2026-03-11T09:00:20Z

KGR: File uploaded with MsUpload

File uploaded with MsUpload