UBIK Wiki Test / Augmensys - User contributions [en]

MRO Objects (Client)

2018-04-24T09:24:54Z

KVA: /* MRO Objects */

[[File:UI_WinX_MRO_ChildList.png|thumb|alt=MRO Child List UI (WinX)|MRO UI (WinX)]]
[[File:Android_mro_ui.jpg|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 indicator is shown on all objects that represent an organisational state or receive the organisational status from subsequent objects in the underlying data branch. This indicator shows the amount of confirmed work done in the data branch. It can as well display a work package to be already confirmed or show tasks that are already locked by their owning workpackage.
<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 shown on all objects that represent the current work progress or receive the work progress cumulated from subsequent objects in the underlying data branch. This indicator shows the amount of work done in the data branch.

<gallery>
File:UI_WinX_MRO_WorkProgressIndicator.png|thumb|MRO Work Progress Indicator (WinX)
File:Android_finished_overlay.PNG|thumb|MRO Work Progress Indicator (Android). The finished overlay is shown once the progress of a MRO object is 100%
</gallery>

{{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. Additionally the Android client shows a Revert Task button underneath tasks.
<gallery>
File:Android_reset_task.PNG|Revert Task button (Android)
</gallery>

{{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 ====
[[File:UI_WinX_MRO_ChildItemMeasurementTask_Empty.png|thumb|Measurement Task without a reported value (WinX)]]
[[File:UI_WinX_MRO_ChildItemMeasurementTask.png|thumb|Measurement Task with a reported value (WinX)]]
[[File:Android_measurement_task_null.PNG|thumb|Measurement Task without a reported value (Android)]]
[[File:Android_measurement_task.PNG|thumb|Measurement Task with a reported value and a previous value (Android)]]
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}}

==== Progress Task ====
[[File:UI_WinX_MRO_ProgressTask.png|thumb|Progress Task with a reported work progress (WinX)]]
[[File:Android_value_reporting_task.PNG|thumb|Progress Task with a reported work progress (Android)]]
[[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}}

==== Check Task ====
[[File:UI_WinX_MRO_CheckTask.png|thumb|Unfinished MRO CheckTask (WinX)]]
[[File:Android_check_task.PNG|thumb|Not Applicable MRO CheckTask (Android)]]
A [[MROCLS_MRO_CHECK_TASK|Check 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}}

==== Inspection Task ====
[[File:UI_WinX_MRO_InspectionTask.png|thumb|Finished MRO InspectionTask (WinX)]]
[[File:Android_inspection_task.PNG|thumb|Finished MRO InspectionTask (Android)]]
[[MROCLS_MRO_INSPECTION_TASK|Inspection 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}}

==== Sequential Task ====
The 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.

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

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

== See also ==
* [[MRO (Plugin)]]

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

File:Task relations.png

2018-04-24T09:24:30Z

KVA:

File:Sequential tasks winx.mp4

2018-04-24T09:22:07Z

KVA:

File:Seq tasks HoloLens.mp4

2018-04-23T11:42:36Z

KVA:

UBIK HoloLens Client Basics

2017-06-27T12:42:01Z

KVA:

== Login ==
The HoloLens App uses the first profile that was found where IsDefault is set to true. If none is found, it will connect to the Demo server automatically.

== Commands ==
The HoloLens App can be controlled with voice commands and gestures.
In '''most''' cases, except for the "Assign POI" and "Refresh POI" voice commands, a ''POI'' can refer to any type of placeable object. In the HoloLens app, this means regular content objects, documents, or tasks.

{| class="wikitable" | width = "100%"
|-
! Command!! Purpose
|-
| ''Create POI|| Creates a new POI at the spot the user is currently gazing at
|-
| ''Assign POI|| Switches the currently focused POI into dictation mode and listens for text input. The text is searched against the data model.
|-
| ''Move POI|| Puts the POI in movement mode. This can also be triggered by AirTapping the POI
|-
| ''Place POI|| Places the POI that is currently being moved
|-
| ''Delete POI|| Removes a POI from the virtual world
|-
| ''Reset world|| Removes all placed POIs and documents from the virtual world
|-
| ''Refresh POI|| Reloads the UBIK object behind the POI
|-
| ''Show documents|| Displays a list of documents associated to the POI. The documents can be picked (AirTap) and placed like regular POIs
|-
| ''Hide documents|| Hides the document list
|-
| ''Show Tasks|| Displays a list of tasks associated to the POI. The tasks can be picked (AirTap) and placed like regular POIs.
|-
| ''Hide Tasks|| Hides the task list
|-
| ''Next|| When documents are shown, brings the next document to the front of the list
|-
| ''Previous|| When documents are shown, brings the previous document to the front of the list
|-
| ''Save objects|| Saves the location of each POI and document to the server (if available)
|-
| ''Load objects|| Restores are previously saved POIs and documents to their previous location by retrieving them from the server (if available)
|-
|}

== POIs ==
POIs are the HoloLens representations of UBIK content objects. To place these POIs in the world, you only need to do the 2 following things:
# Use "Create POI" voice command to create a new empty POI
# Use "Assign POI" voice command, followed by dictating the name of the content object you are looking for
If the assigned name of the POI can be found, the app will assign it to the empty POI, and start loading the object's properties, documents, and tasks.

== Documents ==
Documents are children of POIs, but are treated similarly to POIs. All voice commands which are available for documents are detailed above.
If a POI has document children, the user may view the expanded list (carousel) of document previews by using "Show Documents". The carousel can be navigated using "Next" and "Previous", or by tapping on the individual previews. The documents can then be placed anywhere in the world by tapping the centered preview, and tapping again to release the document (while it loads).

==== Scaling documents ====
The user can scale flat (images and pdfs) and 3D objects once they are placed. For flat documents, the handle in the top right corner must be tapped, while holding down the tap gesture. Then, simply move your hand in any direction to start scaling the document up or down. Release the handle to stop scaling.

3D documents can be scaled similarly. The only difference is that there is no handle. The user can simply tap and drag anywhere on the visible mesh to scale the object.

== Tasks ==
POIs can, besides documents, also have tasks as children. You can view the list of available tasks (if any) by using the "Show Tasks" command. Similar to documents, a list of task previews will be shown. From there, you can place the tasks anywhere in the world, where they can be edited.

==== Editing tasks ====
Once tasks are placed in the world, they become editable. We differentiate between 2 different types of tasks, which are both edited in a slightly different way.
Some tasks will present a list of options, which the user can tap (or dictate) to assign the value to the task.
For others, such as tasks where a number has to be entered, presenting a list would make no sense. Therefore, you can simply dictate the desired value the task should have (which can be anything, depending on the value type of the task).

UBIK HoloLens Client Basics

2017-06-27T12:41:41Z

KVA:

== Login ==
The HoloLens App uses the first profile that was found where IsDefault is set to true. If none is found, it will connect to the Demo server automatically.

== Commands ==
The HoloLens App can be controlled with voice commands and gestures.
In '''most''' cases, except for the "Assign POI" and "Refresh POI" voice commands, a ''POI'' can refer to any type of placeable object. In the HoloLens app, this means regular content objects, documents, or tasks.

{| class="wikitable" | width = "100%"
|-
! Command!! Purpose
|-
| ''Create POI|| Creates a new POI at the spot the user is currently gazing at
|-
| ''Assign POI|| Switches the currently focused POI into dictation mode and listens for text input. The text is searched against the data model.
|-
| ''Move POI|| Puts the POI in movement mode. This can also be triggered by AirTapping the POI
|-
| ''Place POI|| Places the POI that is currently being moved
|-
| ''Delete POI|| Removes a POI from the virtual world
|-
| ''Reset world|| Removes all placed POIs and documents from the virtual world
|-
| ''Refresh POI|| Reloads the UBIK object behind the POI
|-
| ''Show documents|| Displays a list of documents associated to the POI. The documents can be picked (AirTap) and placed like regular POIs
|-
| ''Hide documents|| Hides the document list
|-
| ''Show Tasks|| Displays a list of tasks associated to the POI. The tasks can be picked (AirTap) and placed like regular POIs.
|-
| ''Hide Tasks|| Hides the task list
|-
| ''Next|| When documents are shown, brings the next document to the front of the list
|-
| ''Previous|| When documents are shown, brings the previous document to the front of the list
|-
| ''Save objects|| Saves the location of each POI and document to the server (if available)
|-
| ''Load objects|| Restores are previously saved POIs and documents to their previous location by retrieving them from the server (if available)
|-
|}

== POIs ==
POIs are the HoloLens representations of UBIK content objects. To place these POIs in the world, you only need to do the 2 following things:
# Use "Create POI" voice command to create a new empty POI
# Use "Assign POI" voice command, followed by dictating the name of the content object you are looking for
If the assigned name of the POI can be found, the app will assign it to the empty POI, and start loading the object's properties, documents, and tasks.

== Documents ==
Documents are children of POIs, but are treated similarly to POIs. All voice commands which are available for documents are detailed above.
If a POI has document children, the user may view the expanded list (carousel) of document previews by using "Show Documents". The carousel can be navigated using "Next" and "Previous", or by tapping on the individual previews. The documents can then be placed anywhere in the world by tapping the centered preview, and tapping again to release the document (while it loads).

==== Scaling documents ====
The user can scale flat (images and pdfs) and 3D objects once they are placed. For flat documents, the handle in the top right corner must be tapped, while holding down the tap gesture. Then, simply move your hand in any direction to start scaling the document up or down. Release the handle to stop scaling.

3D documents can be scaled similarly. The only difference is that there is no handle. The user can simply tap and drag anywhere on the visible mesh to scale the object.

=== Tasks ===
POIs can, besides documents, also have tasks as children. You can view the list of available tasks (if any) by using the "Show Tasks" command. Similar to documents, a list of task previews will be shown. From there, you can place the tasks anywhere in the world, where they can be edited.

==== Editing tasks ====
Once tasks are placed in the world, they become editable. We differentiate between 2 different types of tasks, which are both edited in a slightly different way.
Some tasks will present a list of options, which the user can tap (or dictate) to assign the value to the task.
For others, such as tasks where a number has to be entered, presenting a list would make no sense. Therefore, you can simply dictate the desired value the task should have (which can be anything, depending on the value type of the task).

UBIK HoloLens Client Basics

2017-06-27T12:27:50Z

KVA:

UBIK HoloLens Client Basics

2017-06-27T11:34:32Z

KVA:

UBIK HoloLens Client Basics

2017-06-27T07:31:20Z

KVA:

UBIK HoloLens Client Basics

2017-06-27T07:25:43Z

KVA: /* Login */

UBIK HoloLens Client Basics

2017-05-17T07:13:54Z

KVA: /* Commands */

== Login ==
The HoloLens App uses the first profile that was found where IsDefault is set to true. If non is found it will connect to the Demo server automatically.

== Commands ==
The HoloLens App can be controlled with voice commands and gestures.
In '''most''' cases, except for the "Assign POI" and "Refresh POI" voice commands, a ''POI'' can refer to any type of placeable object. In the HoloLens app, this means regular content objects, documents, or tasks.

{| class="wikitable" | width = "100%"
|-
! Command!! Purpose
|-
| ''Create POI|| Creates a new POI at the spot the user is currently gazing at
|-
| ''Assign POI|| Switches the currently focused POI into dictation mode and listens for text input. The text is searched against the data model.
|-
| ''Move POI|| Puts the POI in movement mode. This can also be triggered by AirTapping the POI
|-
| ''Place POI|| Places the POI that is currently being moved
|-
| ''Delete POI|| Removes a POI from the virtual world
|-
| ''Reset world|| Removes all placed POIs and documents from the virtual world
|-
| ''Refresh POI|| Reloads the UBIK object behind the POI
|-
| ''Show documents|| Displays a list of documents associated to the POI. The documents can be picked (AirTap) and placed like regular POIs
|-
| ''Hide documents|| Hides the document list
|-
| ''Show Tasks|| Displays a list of tasks associated to the POI. The tasks can be picked (AirTap) and placed like regular POIs.
|-
| ''Hide Tasks|| Hides the task list
|-
| ''Next|| When documents are shown, brings the next document to the front of the list
|-
| ''Previous|| When documents are shown, brings the previous document to the front of the list
|-
| ''Save objects|| Saves the location of each POI and document to the server (if available)
|-
| ''Load objects|| Restores are previously saved POIs and documents to their previous location by retrieving them from the server (if available)
|-
|}

UBIK HoloLens Client Basics

2017-04-24T15:06:45Z

KVA: /* Commands */

== Login ==
The HoloLens App uses the first profile that was found where IsDefault is set to true. If non is found it will connect to the Demo server automatically.

== Commands ==
The HoloLens App can be controlled with voice commands and gestures.

{| class="wikitable" | width = "100%"
|-
! Command!! Purpose
|-
| ''Create POI|| Creates a new POI at the spot the user is currently gazing at
|-
| ''Assign POI|| Switches the currently focused POI into dictation mode and listens for text input. The text is searched against the data model.
|-
| ''Move POI|| Puts the POI or document in movement mode. This can also be triggered by AirTapping the POI
|-
| ''Place POI|| Places the POI or document that is currently being moved
|-
| ''Delete POI|| Removes a POI or document from the virtual world
|-
| ''Reset world|| Removes all placed POIs and documents from the virtual world
|-
| ''Refresh POI|| Reloads the UBIK object behind the POI
|-
| ''Show documents|| Displays a list of documents associated to the POI. The documents can be picked (AirTap) and placed like regular POIs
|-
| ''Hide documents|| Hides the document list
|-
| ''Next|| When documents are shown, brings the next document to the front of the list
|-
| ''Previous|| When documents are shown, brings the previous document to the front of the list
|-
| ''Save objects|| Saves the location of each POI and document to the server (if available)
|-
| ''Load objects|| Restores are previously saved POIs and documents to their previous location by retrieving them from the server (if available)
|-
|}

UBIK HoloLens Client Basics

2017-04-24T15:04:43Z

KVA: /* Commands */

== Login ==
The HoloLens App uses the first profile that was found where IsDefault is set to true. If non is found it will connect to the Demo server automatically.

== Commands ==
The HoloLens App can be controlled with voice commands and gestures.

{| class="wikitable" | width = "100%"
|-
! Command!! Purpose
|-
| ''Create POI|| Creates a new POI at the spot the user is currently gazing at
|-
| ''Assign POI|| Switches the currently focused POI into dictation mode and listens for text input. The text is searched against the data model.
|-
| ''Move POI|| Puts the POI or document in movement mode. This can also be triggered by AirTapping the POI
|-
| ''Place POI|| Places the POI or document that is currently being moved
|-
| ''Delete POI|| Removes a POI or document from the virtual world
|-
| ''Reset world|| Removes all placed POIs and documents from the virtual world
|-
| ''Refresh POI|| Reloads the UBIK object behind the POI
|-
| ''Show documents|| Displays a list of documents associated to the POI. The documents can be picked (AirTap) and placed like regular POIs
|-
| ''Hide documents|| Hides the document list
|-
| ''Save objects|| Saves the location of each POI and document to the server (if available)
|-
| ''Load objects|| Restores are previously saved POIs and documents to their previous location by retrieving them from the server (if available)
|-
|}

UBIK HoloLens Client Basics

2017-04-24T15:01:25Z

KVA: /* Commands */

== Login ==
The HoloLens App uses the first profile that was found where IsDefault is set to true. If non is found it will connect to the Demo server automatically.

== Commands ==
The HoloLens App can be controlled with voice commands and gestures.

{| class="wikitable" | width = "100%"
|-
! Command!! Purpose
|-
| ''Create POI|| Creates a new POI at the spot the user is currently gazing at
|-
| ''Assign POI|| Switches the currently focused POI into dictation mode and listens for text input. The text is searched against the data model.
|-
| ''Move POI|| Puts the POI in movement mode. This can also be triggered by AirTapping the POI
|-
| ''Place POI|| Places the POI that is currently being moved
|-
| ''Delete POI|| Removes a POI from the virtual world
|-
| ''Reset World|| Removes all placed POIs and documents from the virtual world
|-
| ''Refresh POI|| Reloads the UBIK object behind the POI
|-
| ''Show documents|| Displays a list of documents associated to the POI. The documents can be picked (AirTap) and placed like regular POIs
|-
| ''Hide documents|| Hides the document list
|-
|}

UBIK HoloLens Client Basics

2017-04-24T14:58:54Z

KVA:

== Login ==
The HoloLens App uses the first profile that was found where IsDefault is set to true. If non is found it will connect to the Demo server automatically.

== Commands ==
The HoloLens App can be controlled with voice commands and gestures.

{| class="wikitable" | width = "100%"
|-
! Command!! Purpose
|-
| ''Create POI|| Creates a new POI at the spot the user is currently gazing at
|-
| ''Assign POI|| Switches the currently focused POI into dictation mode and listens for text input. The text is searched against the data model.
|-
| ''Delete POI|| Removes a POI from the virtual world
|-
| ''Reset World|| Removes all placed POIs and documents from the virtual world
|-
| ''Refresh POI|| Reloads the UBIK object behind the POI
|-
| ''Show documents|| Displays a list of documents associated to the POI. The documents can be picked (AirTap) and placed like regular POIs
|-
| ''Hide documents|| Hides the document list
|-
|}