Changes

MRO (Plugin)

1,715 bytes added, Monday at 14:15
A [[MROCLS_PROCEDURE|Procedure Workpackage]] is a specialized Work Package for structured workflows. Its structure is defined in JSON using a workflow editor and can contain Tasks as well as subordinate Procedure Workpackages. Depending on its state, the corresponding objects are created or updated.
Procedure Workpackages can use [[MRO Objects (Client)#Sequential Task|sequential execution]], [[MRO Objects (Client)#Grouped Task|grouped Tasks]], [[#Switch Start Task|branching]], [[#Calculation Task|calculations]], and references to linked data. Their workflows support online and offline use. Steps that require data exchange wait until connectivity is available.
'''Properties'''
| [[#Signature Task|Signature Task]] || SIGNATURE_TASK || Captures a handwritten signature
|-
| [[#Supervisor Check Task|Supervisor Check Task]] || SUPERVISOR_CHECK_TASK || Applies the four-eyes principle to a [[#Check Task|Check Task]]
|-
| [[#Switch End Task|Switch End Task]] || SWITCH_END_TASK || Rejoins the branches of a Procedure workflow
| [[#Text Task|Text Task]] || TEXT_TASK || Records free-form text
|}
 
{{Hint|For the available Procedure variants and their workflow execution, see [[#Procedure Task Variants and Workflow Execution|Procedure Tasks]].}}
=== Blinding Task ===
Classification: [[MROCLS_BLINDINGTASK]]
A [[MROCLS_BLINDINGTASK|Blinding Task ]] documents either a blinding or deblinding operation at a linked blinding location. The configured operation type determines the state that must be reported to complete the task.
'''Relevant properties'''
| LK_BLINDING_LOCATION || Link to the associated blinding location
|-
| LK_PREVIOUS_TASK || Link to the preceding [[#Blinding Task|Blinding Task]]
|-
| LOCKED || Prevents the task from being edited
Classification: [[MROCLS_COMMISSIONINGCHECK]]
A [[MROCLS_COMMISSIONINGCHECK|Commissioning Task ]] is a specialized task type used in MRO commissioning workflows.
'''Relevant property'''
Classification: [[MROCLS_MRO_CHECK_TASK]]
An [[MROCLS_MRO_CHECK_TASK|Interface Task ]] waits for another software system to provide its completion value. The task is complete when its Boolean '''VALUE''' becomes true. If the client is offline, the task waits until connectivity and synchronization are available again.
'''Properties'''
Classification: [[MROCLS_JOINTTASK]]
A [[MROCLS_JOINTTASK|Joint Task ]] documents the state of a linked joint location. The user selects one of the available Joint States.
'''Relevant properties'''
* Verified
The [[#Joint Task |Joint Task]] is complete when its state is '''Planned''' or '''Closed'''.
=== Measurement Task ===
</gallery>
=== Numeric Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ===
Technical object name: '''NUMERIC_TASK'''
A [[MROCLS_MRO_NUMERIC_TASK|Numeric Task]] records a Double value, for example a value read from a temperature sensor. Entering a value or selecting ''Not Applicable'' completes the task.
The value is compared against a configured acceptable range that cannot be edited on the client. A value outside the range produces visual feedback and sets the [[MRO Objects (Client)#Technical Status|technical status ]] to indicate an issue. An invalid configured range, such as a minimum greater than the maximum, also produces an issue when a value is entered.
A value unit can be configured for an individual task. When present, it overrides the standard unit configured on the [[MetaProperty#Unit_Item|MetaProperty]].
|}
=== Pick List Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ===
Technical object name: '''PICKLIST_TASK'''
|}
=== Picture Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ===
Technical object name: '''PICTURE_TASK'''
|}
An [[MRO_PROGRESS_TASK_EDITOR|alternative editor]] is available for [[#Progress Task|Progress Tasks]].{{Version/WinXSince|2.5.4}}
<gallery widths=497px heights=69px>
</gallery>
=== Signature Task {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ===
Technical object name: '''SIGNATURE_TASK'''
Classification: [[MROCLS_SIGNATURE_TASK]]
A [[MROCLS_SIGNATURE_TASK|Signature Task ]] is completed by capturing a handwritten signature. Selecting the signature editor opens an in-app dialog in which the user can sign. Confirming the signature saves it and automatically completes the task.
When signing while online, the server resolves and displays the signee and generates the validation timestamp. When signing offline, the signee is resolved and displayed once the client is online again. If the complete signee or validation timestamp cannot be displayed in the editor field, selecting the field opens a popup with the complete information.
|}
=== Supervisor Check Task {{Version/XamarinSince|4.8}} ===
Technical object name: '''SUPERVISOR_CHECK_TASK'''
Classification: [[MROCLS_MRO_SUPERVISOR_TASK]]
A Supervisor Check Task applies the four-eyes principle to a Boolean [[#Check Task |Check Task]] on one device. The worker hands the device to a supervisor. The supervisor scans an NFC tag and enters the supervisor PIN. After successful authentication, the checkbox is enabled and must still be selected to finish the task.
Selecting ''Not Applicable'' does not require supervisor authentication.
! Name !! Data type !! Description
|-
| VALUE || {{Boolean}} || [[#Check Task |Check Task]] completion
|-
| SUPERVISOR || {{Guid}} || Authenticated supervisor
Classification: [[MROCLS_SWITCH_END_TASK]]
A [[MROCLS_SWITCH_END_TASK|Switch End Task]] marks the point at which the two branches created by a [[#Switch Start Task |Switch Start Task]] merge again. It is linked to exactly one corresponding [[#Switch Start Task|Switch Start Task]]. It is not shown to the user and completes automatically after the selected branch has finished, allowing the common Procedure workflow to continue.
'''Properties'''
| VALUE || {{Boolean}} || Task completion
|-
| LK_SWITCH_START_TASK || {{Guid}} || Link to the corresponding [[#Switch Start Task|Switch Start Task]]
|}
Classification: [[MROCLS_SWITCH_START_TASK]]
A [[MROCLS_SWITCH_START_TASK|Switch Start Task]] is a sequential workflow-control task used in a Procedure Workpackage. It automatically evaluates a Boolean expression on the client and selects either the true or false branch. Each branch represents a different path of Tasks and must lead to a corresponding [[#Switch End Task|Switch End Task]].
'''Properties'''
Classification: [[MROCLS_TEXT_TASK]]
A [[MROCLS_TEXT_TASK|Text Task ]] allows the user to enter free-form text. Entering a value or selecting ''Not Applicable'' completes the task.
'''Properties'''
|}
== Supervisor Base Type {{Version/XamarinSince|4.8}} ==
Technical object name: '''SUPERVISOR_TASK'''
Classification: [[MROCLS_MRO_SUPERVISOR_TASK]]
[[MROCLS_MRO_SUPERVISOR_TASK|Supervisor Task ]] is a base type that provides supervisor authentication behaviour. It is not used as a standalone user task. The concrete task type using this behaviour is [[#Supervisor Check Task|Supervisor Check Task]]. == Procedure Task Variants and Workflow Execution {{Version/MobileSince|5.1}}{{Version/WinXSince|5.1}} ==
== Procedure Task Variants {{Hint|For the complete list of base task types and Workflow Execution ==their task-specific behaviour, see [[#MRO Task Types|MRO Task Types]].}}
Procedure variants are specialized versions of task types for use within Procedure Workpackages. They retain the behaviour of their corresponding task type and additionally implement the [[MROCLS_SEQUENTIALTASK|Sequential Task]] and [[MROCLS_GROUPEDTASK|Grouped Task]] classifications.
Procedure variants are available for:
* [[#Calculation Task|Calculation Task]]* [[#Check Task|Check Task]]* [[#Inspection Task|Inspection Task]]* [[#Interface Task|Interface Task]]* [[#Numeric Task|Numeric Task]]* [[#Pick List Task|Pick List Task]]* [[#Picture Task|Picture Task]]* [[#Signature Task|Signature Task]]* [[#Supervisor Check Task|Supervisor Check Task]]* [[#Text Task|Text Task]]
[[#Switch Start Task|Switch Start Tasks]], [[#Switch End Task|Switch End Tasks]], and [[#Calculation Task|Calculation Tasks ]] provide automatic workflow-control behaviour in a Procedure Workpackage.
For automatic [[#Calculation Task|Calculation Tasks]] and [[#Switch Start Task|Switch Start Tasks]], the clients display an evaluation indicator:
* '''Finished:''' The Task was automatically evaluated successfully.
* '''Pending:''' The Task has not yet been evaluated. No additional indicator is displayed for this state.
When a predecessor [[#Switch Start Task |Switch Start Task]] has not yet finished, its follow-up Procedure Tasks are hidden because the relevant branch is not yet known. After evaluation, the selected branch becomes visible. The other branch remains hidden, is not executed, and its Procedure Tasks are set to ''Not Applicable''.
For example, several predecessor [[#Numeric Task|Numeric Tasks ]] can record temperatures from different parts of an equipment. A subsequent [[#Calculation Task |Calculation Task]] can calculate their average. A [[#Switch Start Task |Switch Start Task]] can then select a branch based on whether the average exceeds a configured temperature. One branch can contain a Task for activating a cooling mechanism, while the other branch can lead directly to the [[#Switch End Task |Switch End Task]] or contain further [[#Switch Start Task|Switch Tasks]].
Procedure Tasks are intended to execute automatically when their predecessors are finished. However, the completion of the predecessor has to be triggered by a user. If a predecessor becomes finished only because of a server update, the follow-up Procedure workflow is not triggered. This prevents a workflow from executing in the name of users who did not initiate or observe the completion.
Technical object name: '''FILEDOCUMENT_MRO_JSON'''
This File Document stores the JSON definition of a [[#Procedure Workpackage|Procedure Workpackage]].
{| class="wikitable" width="70%"
! Name !! Data type !! Description
|-
| LK_PROCEDURE_WORKPACKAGE || {{Guid}} || Link to the associated [[#Procedure Workpackage|Procedure Workpackage]]
|}
Technical object name: '''FILEDOCUMENT_MRO_PICTURE_TASK'''
This is a dedicated File Document linked to a [[#Picture Task|Picture Task]]. A [[#Picture Task|Picture Task ]] can also use another child-document type, provided that the child document contains a valid file.
{| class="wikitable" width="70%"
! Name !! Data type !! Description
|-
| LK_PICTURE_TASK || {{Guid}} || Link to the associated [[#Picture Task|Picture Task]]
|}
420
edits