Wizard¶
Definition¶
A wizard is an external, step-by-step form for someone who has no access to the Case Manager: a client or an applicant fills it in through a link, usually sent by email. It reads and writes the same case data the Case Manager does, laid out across steps instead of tabs.
A wizard template belongs to a process and has one of three types:
- Creation: filling it in starts a new case.
- Ongoing instances (new in Atfinity 15): continues an existing case, scoped to a chosen set of instances that still need information.
- Ongoing whole case (new in Atfinity 16): continues an existing case as a whole, rather than specific instances.
Ongoing wizards are created from the Wizards tab of a case, for one email address, and are offered only where a condition on their template matches, the same way a rule condition does. An ongoing template without a condition works the other way round (new in Atfinity 17): it starts for a single instance, from a button on the pages of that instance or over the API, and creates the case it runs on.
Steps before the form¶
A cover step can come first, with its own image and text. An ongoing wizard usually starts with an authentication step, confirming the address the wizard was created for, and starts with a form step only where the system that started it has authenticated the person already. A creation wizard can have one too, where the person registers their own address instead. Confirming the address sends a single-use link that expires after ten minutes.
Status¶
A wizard starts as created, becomes opened when its link is followed, and
completed when it is submitted.
One still in created can be withdrawn.
One
that has been opened can be set to inactive instead, which keeps its answers
and stops further work on it.
Finishing the case completes every wizard still
open on it.
Reason about status and type in rules with
WIZARD, or across a
case with CASE.wizards.
Example¶
A bank emails a 'Client Onboarding' creation wizard to a prospective client, who fills in their personal details and signs documents without ever seeing the Case Manager. Once the case exists, a case manager can send an 'Update Details' ongoing-instances wizard to the same client, scoped to just their person instance, whenever their address changes.