Configuring a Wizard¶
A wizard is configured as a template on a process. The template decides what the wizard does to the case, how someone gets into it, and what each step shows.
Choosing the type¶
A template has one of three types, and the type is what decides whether the wizard creates a case or continues one.
- Creation: filling the wizard 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.
Reach for an ongoing-instances template where you know which instances the person has to answer for, such as one client updating their own details, and for ongoing whole case where the wizard covers the case regardless of who is in it.
Deciding how it starts¶
An ongoing wizard is created from the Wizards tab of a case, for one email address. A template is offered there only where its condition matches, the same way a rule condition does.
An ongoing template can also start outside a case (new in Atfinity 17), through one of two switches, both off by default:
- Can be started from an instance: the wizard starts for a single instance and creates the case it runs on.
- Can be started over the API: another system starts it and takes back the link, see Start wizards. A creation template carries this switch as well.
Two things lock both switches. Setting a condition locks them, since a condition is what offers a wizard inside a case. An ongoing template on a creation process locks them too, because only an ongoing template on a lifecycle process can start outside a case.
A creation template started over the API also picks the entry step the person lands on, instead of the cover step a plain link opens 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 wizard started from an instance has no such address, so the person enters their own and the wizard keeps it from then on. 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.
Building a step¶
A step's layout holds categories and fields, the same building blocks as a process layout. Three components exist only here.
Super categories¶
Info
New in Atfinity 17.
A super category is a component you place among the categories in a step. It has no description and no fields of its own, so moving it does not move any content with it, unlike moving a category.
Its title is either fixed, or calculated with a RuLa formula, the same principle used to name a case or an instance. On a step that repeats per instance the formula is evaluated once for each one, so every section is named after the instance whose fields follow. An instance whose formula returns nothing falls back to the fixed title.
On a step that repeats for every 'Beneficial Owner' instance, a super category with a calculated title announces whose fields follow, without moving those fields if it is repositioned.
Descriptions¶
Info
New in Atfinity 17.
A field, a category and a structure information can each have a description, the same text already used as help text in the Case Manager, and that description can also be shown in the wizard.
A description is rich text and supports bold, italic, bulleted and numbered lists, and links. Any other formatting, such as strikethrough or a code block, is dropped when you paste it in. An item without a description has nothing to show, regardless of its toggle.
Each field, category and structure placed in the wizard has its own toggle for this, on by default. A field or category placed on more than one step has an independent toggle for each placement. Fields inside a structure's occurrences are the exception: their toggle is set once on the structure's own field layout and applies wherever that structure is used, rather than per step.
Documents and booklets¶
Info
New in Atfinity 17.
A file field resolves to one document or booklet of the case with a RuLa expression, and lets the end user download it.
The expression is required and must resolve to exactly one document or booklet, for example through
CASE.documents_by_key, an instance's documents_by_key, or
CASE.booklets_by_key.
If it resolves to anything else, or to nothing for the current case, the file field does not appear in the wizard at
all.
A file field can also let the end user view the resolved document or booklet inside the wizard, in addition to downloading it. This is off by default.
Following a wizard once it is out¶
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.