Handover mode

The employee hands their own device – usually a tablet – to the person who signs. The handover mode locks the session to the signing page, so the signer cannot reach anything else in the application.

service('handover')->start($panel, $document, $returnPath);

Argument	Meaning
$panel	the panel whose signing page is used
$document	the draft
$returnPath	where the employee lands after unlocking, a path of the application (/admin/people/…)

The Hand over button of the documents list does the same.

While the mode runs

• Every page of every panel leads to the signing page (/<panel>/handover); only the signing page and the component endpoint are reachable (anvil-handover filter).
• Every component other than the signing page is rejected at the endpoint.
• The layout shows no navigation, search, notifications, tenant switcher or user menu.
• The mode lives in the session of the employee; another device of the same employee is not affected.

The signing page

The signer sees:

1. the document as it will be printed,
2. the confirmation text with a checkbox (if the template has one),
3. the name field, filled with signerName() of the template,
4. the signature field (pen with pressure, finger or mouse) with Clear,
5. Sign.

After signing, the page shows that the document is signed and waits for the employee.

Back to the employee

Account	How
with password	the employee enters their password; they return to $returnPath
without password (single sign-on)	Log out; the employee logs in again

Five wrong passwords log the employee out (MAX_ATTEMPTS). Every failed attempt is audited (document.handover_unlock_failed).

Audit entries

document.handover_started when the mode starts, document.handover_ended with how it ended (unlocked, logout) and whether the document was signed.

In code

Method of service('handover')	Purpose
start($panel, $document, $returnPath)	starts the mode
current()	the running handover of the session (panel, document, signed, attempts, return path) or null
unlock($password)	ok, wrong or logout
logout()	ends the mode and the session
end($how)	ends the mode without logout