Changes

[[File:MRO_MAUI1.jpeg|thumb|alt=MRO Child List UI (AndroidMobile)|MRO UI (AndroidMobile)]]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 WinX and Mobile clients display MRO features comprises some objects like other root or child objects, with additional MRO-specific 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 branchevaluation logic. 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:

The {| class="wikitable"|-! Page !! Scope|-| [[MRO (Plugin)]] || MRO concepts, task types, task-specific behaviour, and relevant technical properties|-| '''MRO Objects (Client)''' || Common client presentation, 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 damagedindicators, locking, its parent and behaviour shared by multiple MRO objects will all display the exclamation mark symbol to indicate that a problem was reported in the child items.|}

{{Hint|For the complete list of MRO task types and their task-specific behaviour, see [[File:TechStats_WinX.png|100px|Technical Status Indicator MRO (Winx & MobilePlugin)#MRO Task Types|MRO Task Types]].}}

==Basic User Interface = 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>

 === 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 organisational status represents the amount of confirmed 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 This includes confirmed Work Packages as 99.8%. The format string used to achieve this is <code>{0:0.#}%</code>. If other numeric formats well as Tasks that 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 informationlocked by their owning Work Package. The template to customize for this indicator is the UBIKMROProgressBadge within UBIKThemes. {{Clear}}       == MRO Objects ==A set of specific shown on objects can be used to provide the required structure for MRO: === Task Owner ===A [[MROCLS_MRO_TASKOWNER|Task Owner]] is that represent an object having a substructure of jobs to be done. It can have a tree of other task owners organisational state or work packages underneath that will update receive the organisational 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 from subsequent 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.

File:ConfirmingWP_WinXOrgaStatusIndicatorWinX.pngPNG|MRO Workpackage confirm button Organisational Status Indicator (WinX)File:MRORevoke_WinXConfirmedWP_WinX.png|MRO Workpackage revoke confirmation button Confirmed Work Package flag (WinX)File:ConfirmingWP_MAUI.jpeg|MRO Workpackage confirm button (Android)File:MRORevoke_MAUIConfirmedWP_MAUI.jpeg|MRO Workpackage revoke confirmation button Confirmed Work Package indicator (AndroidMobile)

=== Task Work Progress ===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 Work progress is calculated from the Not Applicable buttonobject's current progress and the progress accumulated from subsequent objects in the underlying data branch. The indicator shows the amount of work completed in that branch.

<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>MRO Objects ==

==== Progress Task =Work Package ===

The clients provide controls for confirming and revoking the confirmation of a [[MROCLS_MRO_PROGRESS_TASKMROCLS_MRO_WORKPACKAGE| Progress TaskWork Package]] 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 A Work Package can also be finished with confirmed when its related Tasks have reached the option ''Not Applicable''required progress and all subordinate Work Packages have been confirmed.

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 UWPConfirmingWP_WinX.png|Progress Task with a reported work progress Work Package confirmation button (WinX)File:Progress Task AndroidMRORevoke_WinX.png|Revoke Work Package confirmation (WinX)File:ConfirmingWP_MAUI.jpeg|Work Package confirmation button (Mobile)File:MRORevoke_MAUI.jpgjpeg|Progress Task with a reported work progress and a previous progressRevoke Work Package confirmation (AndroidMobile)

==== Check {{Hint|For the complete list of MRO task types, their properties, and their task-specific client behaviour, see [[MRO (Plugin)#MRO Task ====Types|MRO Task Types]].}}

A [[MROCLS_MRO_CHECK_TASK|Check ==== Sequential 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 The [[MROCLS_SEQUENTIALTASK|Sequential Task finished UWPclassification]] defines an order in which Tasks are to be completed.png|Unfinished MRO CheckTask (WinX)File:Check One or more predecessor Tasks can be required to finish before a dependent Task androidbecomes unlocked and editable. A Task can have any number of predecessors.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 configured dependency graph must 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 casecontain cycles. The state of Tasks within 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 dependency cycle could never become 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 finishedcompletion.

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

The idea [[MROCLS_GROUPEDTASK|Grouped Task classification]] is, used when only a group configured number of tasks can Tasks from a group have to be defined as finished. The Tasks are siblings to each other and they also share the same a server -configured threshold. When the number of finished tasks among that group exceeds Tasks reaches the threshold, the entire remaining Tasks in the group is are considered as no longer necessary. When reflected in For the overall accumulated status of the task owner(s)owning objects, these tasks would appear those Tasks are treated as if they are were finished.

{{Hint|Technically speaking, the The finished status is completely independent from state and the not no-longer-necessary status on a taskstate are independent. A grouped task which Grouped Task that is no longer necessary can be both either finished or unfinished. Users do not yet finished. In other words, users don't have to finish a not necessary grouped taskit, but they still can.}}

{{Hint|The precise status calculation for grouped tasks and their task owners requires the knowledge of information about all sibling Tasks. If some siblings tasks. Imagine 2 out of 3 tasks must be finished but the client only knows 1 in total and the others are only not available at offline, the server at that time. This makes it impossible to draw conclusions client cannot determine whether the task(s) should be necessary or notthreshold has been reached. Under such circumstancesIn this situation, the local status calculation is done treats the available objects as if these are just regular tasksTasks.}}

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

A task Task can also be a both grouped and a sequential one at the same time. In such a this case, the grouped nature of the sibling tasks will affect the way the task sequence completesgroup threshold affects when a dependent Task becomes available.

For example, task Tasks 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 form 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 group 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.       ==== Picture one 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]]finished. {{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 all three 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 predecessors 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 valueB, finishing one of them causes the [[#Tech Status|tech status]] will also be set group threshold to display an issue.* A numeric task also has a special value unit that can be set per task instancereached. 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''. ==== Procedure Tasks {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ==== Procedure tasks are [[#Sequential_Task|sequential tasks]] that can define a more complex workflow with task branching. There are All three specific types of procedure tasks: [[MRO_(Plugin)#Switch_Start_Task|switch (start) tasks]], [[MRO_(Plugin)#Switch_End_Task|switch end tasks]] predecessors become no longer necessary and [[MRO_(Plugin)#Calculation_Task|calculation tasks]]. As a simple examplelocked, you can configure several predecessor tasks to measure the temperatures of different parts of an equipment and then a follow-up calculation task to compute the average of them. Then a follow-up of that can be a switch task which determines the follow-up task branch. If the average temperature is above 30°C, the follow-up task is to turn on the cooling mechanism. The other branch can be directly the end of the switch, but it can also include further switches depending on the actual required workflows. The technical details of these tasks can be found in the links above. For both switch (start) and calculation tasks, a symbol is displayed in the UI to reflect its following evaluation status.* Finished: The task is automatically executed/evaluated successfully;* Error: The task was automatically executed/evaluated but resulted in an error.{{Hint|Technically speaking, there's a pending status as well for when a procedure task is not yet automatically executed/evaluated. But the UI doesn't additionally display anything for that.}} When a predecessor switch task is not yet finished, its follow-up procedure tasks are hidden because it's simply unknown which ones are relevant for the users. Once it's finished, the branch to follow appears while the other branch remains hidden. Additionally, all procedure tasks in that other branch get set to NA (not applicable). {{Hint|Procedure tasks are meant to execute automatically without user inputs as soon as their predecessor(s) is/are finished. However, the finishing of such a predecessor task must be triggered by the users. If such a predecessor task Task B becomes finished due to e.g. a server update, the follow-up procedure related workflow does not trigger. This is an intentional design to avoid having the workflow triggered in the name of the users even when they are not responsible for or even aware of itunlocked. }}