Difference between revisions of "Commissioning Objects (UBIK Android)"

Revision as of 15:31, 24 August 2015

UI Representation of Commissioning Task Objects

A commissioning task is a special task object, which displays properties defining the status of the check on the row level directly.

There are two types of commissioning tasks,

state relevant tasks which are indicated by a circle with or without a check at the left side of the row as well as the "Not Applicable" icon. The later icon is a circle with a diagonal line in it at the end of the row.
non state relevant tasks, which can be seen as some kind of informational object which do not have a status. This line is indicated by a white "i" as icon and does not have the "Not Applicable" icon.

All commissioning tasks, no matter of what type, are intended to be nested into a parent object called commissioning workpackage, which provides the functionality to close all underlying tasks and synchronize them with the server (triggering some optional workflow).

A commissioning task is finished only if a value is entered or the "Not applicable" icon is toggled accordingly.

Any value not equal to null is a valid property value, which means that also a value false for a boolean property is valid.

The boolean status is reflected through the checkbox' color: dark blue if it has not been set yet, white if set and white / empty if it is false.

Task types

Information commissioning task

This task is indicated by the white "i" in front of the row. It is intended to hold further information for the user, like additional photos or just a note for the engineer which is not relevant for the status of the whole commissioning process. Nevertheless, it is possible to give it a value like the other tasks which is of course synchronized with the server at least if the commissioning workpackage gets finished.

State relevant commissioning task

All tasks like checking if a functional plan is available, certain protocolls are in place and updated or entering some specific values is handled with these tasks. It is also possible to check a task as "Not Applicable" if a task is not possible to be done at the moment but should be seen as finished.

The icon leading the row is indicating the completion status of the task. A task is finished once the value is not null OR the "Not Applicable" icon is toggled. This means even a boolean property FALSE means a task is finished. It is possible to both fill out a tasks property and toggle it as "Not Applicable".

Commissioning Workpackage

Architecture of status calculation

A workpackage contains tasks of the above mentioned two types. The UI is showing an extra line on bottom of the content browser once navigated into a workpackage which shows an icon and a button with an integrated icon. The standalone button visualizes the calculated sum of all status of underlying state relevant commissioning tasks which means that as long as at least a single child object is not finished and therefore shows an empty circle, the whole workpackage is regarded as (technically) not finished. The icon within the button visualizes the workpackage status which is a property assigned to the workpackage. Resulting out of this, a workpackage has four possible states:

Workpackage status OPEN | technical status OPEN
Workpackage status FINISHED | technical status OPEN
Workpackage status OPEN | technical status FINISHED
Workpackage status FINISHED | technical status FINISHED

Clicking the button attemps to switch the workpackage status and if the workpackage is changed from open to finished, it triggers a sync of the whole workpackage. As some kind of convinience, popup editors for all state relevant and not filled out (technically open) child tasks pop up and give the user the possibility to fill out the missing value but can be canceled of course.

For now, it is possible to change underlying commissioning tasks even if the workpackage is finished.

If a commissioning workpackage does not contain any commissioning checks or if they are not yet fetched by the server, the technical status displayed at the bottom left corner is FINISHED!

Following gallery should give an overview about all possibilities that can occur upon using this feature:

New commissioning workpackage
Open commissioning workpackage with open child tasks
Open commissioning workpackage with technically finished tasks
Convinience method for not technically finished tasks upon closing workpackage
Finished commissioning workpackage with open child tasks
Finished commissioning workpackage with technically finished tasks

@@ Line 13: / Line 13: @@
 The boolean status is reflected through the checkbox' color: dark blue if it has not been set yet, white if set and white / empty if it is false.}}
-== Information commissioning task ==
+== Task types ==
+=== Information commissioning task ===
 This task is indicated by the white "i" in front of the row. It is intended to hold further information for the user, like additional photos or just a note for the engineer which is not relevant for the status of the whole commissioning process. Nevertheless, it is possible to give it a value like the other tasks which is of course synchronized with the server at least if the commissioning workpackage gets finished.
-== State relevant commissioning task ==
+=== State relevant commissioning task ===
 All tasks like checking if a functional plan is available, certain protocolls are in place and updated or entering some specific values is handled with these tasks. It is also possible to check a task as "Not Applicable" if a task is not possible to be done at the moment but  should be seen as finished.