View source for Safety Instructions

[[File:UBIK_Android_UI_Content_Browser_Safety_Instructions.png|400 px|thumb|border|alt=Safety Instructions|Safety Instructions]]

In certain use cases, the user should receive safety instructions before an object is opened in the {{Content Browser}}.

For example, imagine some objects in the data model represent work packages, describing tasks to be done in predictive maintenance. If some of these work packages require the user to confirm safety instructions before their tasks can be worked on, this feature provides showing a list of documents the user has to read and confirm before the work package can be opened in the ''Content Browser''.

== Behaviour ==
Whenever a user tries to open a [[SYSCLS SAFETY RELEVANT OBJECT|safety relevant object]] in the ''Content Browser'', a safety check dialog will be shown.
This dialog shows all [[SYSCLS SAFETY RELEVANT DOCUMENT|safety documents]] that must be read before proceeding.

The instructions can be confirmed with the button at the bottom of the dialog. Once confirmed, the object is opened (and underlying children as well as properties can be modified if not prohibited otherwise). <br/>
This check doesn't appear again if the user already confirmed the checks (except if the property storing that information was changed).

It does not matter where the attempt to open a safety relevant object in the ''Content Browser'' came from (e.g. QR marker scan result or an AR view).

{{Hint|The safety instructions dialog is only opened before a respectively classified object is shown in the ''Content Browser''. <br/>This means: For example if a task is classified, editing it from its parent's children list view will not be intercepted. In this case you should classify the parent object instead. <br/>Also, this feature doesn't intercept editing an object per se. For example in case any other methods for editing an object are used, without opening it or its parent object in the ''Content Browser'' first, no safety instructions would be shown.}}



== Customizing ==

When this article was created, the pages for the required classifications were still under construction.
However, there are two classifications necessary for the feature to work:

=== Safety Relevant Object Classification ===


{| class="wikitable" | width = "50%"
|-
! UID !! colspan="2" | a28ca629-4174-43dd-93f8-188e8395b616
|-
! Property !! Type !! Meaning 
|-
| SAFETYINSTRUCTIONCONFIRMED || Boolean ||  Stores whether the user has confirmed the safety instructions (can be used in combination with the session ID on the server) 
|- 
| NUMBEROFSAFETYDOCUMENTS || Integer ||  Tells the UBIK Android client how many safety document children are to be expected.
|-
|}

This classification is used to configure objects that require safety instructions before being shown in the ''Content Browser''.


=== Safety Document Classification ===

{| class="wikitable" | width = "50%"
|-
! UID !! colspan="2" | 8d66e0db-877f-46b5-83af-f691ad8f5df3
|-
! Property !! Type !! Meaning 
|-
| SEEN || Boolean || Stores whether the user has already seen this document or not (can be used with the Session ID on the server).
|- 
|}

This classification is used to configure safety instruction documents as children of a safety relevant object.