====== Multi-Access-Handling ======

If more than one user can access the same [[:en:software:tim:smartform_basics|smartform]] simutanously, it is recommended to lock the editing for other users, when one user opens it.

This blockade also works in the preview window in the ToDo-Client, but not in the preview window of the processmanager client, because it displays the [[:en:software:tim:multiaccess#special_accesses_to_the_smartform_that_are_not_affected_by_the_blocking|view's special case]].

Will man nur gewisse Bereiche einer Smartform bei Bearbeitung blocken, so wird in diesem [[:software:tim:section_handling?s[]=section&s[]=lockable#locking|Artikel]] näheres dazu erklärt. If you want to lock only certain parts of the smartform, go to this [[:en:software:tim:section_handling?s[]=section&s[]=lockable#locking|article]].

The options are explained in this article with disadvantages and advantages.

----

===== Multi-Access-Handling via the Smartform =====

An advanteg of this method is: The properties file does not have be edited, instead the handling is regulated via a [[:en:software:tim:smartform_basics|smartform]]-attribute. Moreover does this setting only effect one process/[[:en:software:tim:smartform_basics|smartform]], this means the others keep their settings.

To do this, the form-elemnt has to contain the attribute ''multiAccess=REPLACEME''.

3 values can be assigned to this attribute.

==== true: ====

''multiAccess = "true"'' is the default setting, this means more than one user can access the smartform.

==== false: ====

''multiAccess = "false"'' means that the smartform is not editable immediately, to edit it the pencil icon has to be clicked first. When this happens, the smartform is locked for every other user until the editor closes the smartform.

If a smartform is being edited, every other user can see who is editing.

1. User 1 opens the smartform first:

{{:en:software:tim:multiaccess1.png?400  }}
\\
\\
\\
\\
2. User 2 opens the smartform, after suer 1 clicked on edit "smartform":

{{:en:software:tim:multiaccess2.png?400  }}

\\
==== auto: ====

''multiAccess = "auto"'' means that the smarform is automatically locked when someone opens the smartform. Others cannot edit the smartform unless the editing user closes the smartform. This means that with this setting it is not possible to "just" view a smartform without preventing the editing.

----

===== Multi-Access-Handling via the tim.properties file =====

This is especially useful if Multi-Access-Handling occur for every process/smartform. Because a change in the [[en:software:tim:tim.properties|tim.properties]] file has an effect globally (all clients and processes):

The line ''form-access-mode=REPLACEME'' has to be added to the propereties file.

This time the are again 3 different values:

==== multi ====

''form-access-mode=multi'' is the default setting, this means more than one user can access the smartform.

==== single ====

''form-access-mode= false'' means that the smartform is not editable immediately, to edit it the pencil icon has to be clicked first. When this happens, the smartform is locked for every other user until the editor closes the smartform.

==== single-auto ====

''form-access-mode=auto''  means that the smarform is automatically locked when someone opens the smartform. Others cannot edit the smartform unless the editing user closes the smartform. This means that with this setting it is not possible to "just" view a smartform without preventing the editing.

----

===== Unlocking the Smartform =====
A locked smartform can be unlocked via different events. After one of the following resolves, one click on the smartform is enough to edit it.

==== Closing the Smartform ====

When the editing user closes the smartform, it is unlocked for editing.

==== Finishing the Task ====

When the editing user finished the task, the smartform is unlocked for editing.

==== Logout ====

If a user closes tim, while he was working on the task, the smartform is unlocked for editing.

==== Timeout (30m) ====

If a user starts to edit a smartform. but does not change anything for 30 minutes, the editing right is revoked and the smartform is unlocked for editing.

If you want to set the time, e.g. longer or shorter, adding the line ''section timeout=XX'' in the properties will do the trick. The XX is the desired time in minutes.

----

===== Special accesses to the smartform that are not affected by the blocking =====

If a user has the starter role, he can not only see the current task, but also the instances of a process. If such a user accesses the smartform via the instance view, he does not block the smartform and he cannot be blocked by other users.