What are Collections?
If a BRYTER author enables allow multiple responses inside the node editor, end-user can dynamically enter multiple entries of the same (multi-) input node. Once allow multiple responses is activated, the node icon in the graph and list view will be replaced with a different, blue collection icon.
Why would you use Collections?
Collections allow you to dynamically collect the appropriate number of responses for a certain question. Authors do not need to set up input nodes for multiple entries and ask the end-users how many entries they are planning to provide.
The values entered for this input can be displayed in nodes by @-referencing or could be used to populate a document or to be written into a database.
How do you use Collections?
1. Activate toggle Allow multiple responses in input node
Authors can enable collections when editing a node and switching on the toggle Allow multiple responses on the right hand side in the list of option for input nodes.
2. Reference collection in input nodes, result nodes and text block value nodes
For authors of the module, collections can be referenced by using an '@' - sign in the content field of any input node, result nodes and text block value nodes. This will add a "Collection Block" in which the inputs provided by the end-user can be displayed. Authors can also add text between the referenced values of a collection block.
3. Set conditions
Conditions set on collection blocks cannot be used as filters but only to verify if one of the entries for an input equals, contains or matches a value. This means you cannot exclude an entry from a collection block but display different content if a certain entry satisfies the condition.
Conditions in collections
- Select the relevant item in BRYTER: Nodes where allow multiple answers is activated, i.e. collections, will be depicted with a darker blue icon.
- Define the evaluation scope of the condition: Specifies which elements (ALL, ANY, or NONE) of the collection must satisfy the (nested) condition
- Select the correct operator: Depending on the node type selected in (1), select how to condition the item.
- Type or reference the value of the conditional statement
- Logical connector: Defines how single lines of conditions or groups of conditions are connected with all ALL connecting conditions with a logical AND and OR representing the logical OR
In the end-user interface of the published module, the end-user will be presented with the option to add another entry when the input node, where allow multiple answers is activtated, is displayed. The end-user can add up to 20 entries and delete entries that were not required. As soon as all required input fields in the respective entry are provided, the Next button can be clicked.
The entire collection can be displayed to the end-user in any following content field of an input node or a result.
👍 Good use case examples: Board Meeting Generator
If you want to ask for attendees and absentees for a board meeting, you had to either set input nodes to optional or ask for the exact number first to display the correct amount of input nodes. With collections, you can now enable dynamic inputs.
Other use case examples include:
- Shareholder Agreements
- Incorporation questionnaire
- To-do lists or any bullet point list
👎 Bad use case examples
It's not possible to filter certain entries in a collection block and display those that only contain certain values. If your use case relies on this, you might need to consider setting up several textblock values or use several input nodes to let end-user enter a pre-defined number of entries.
💡 Best practice
- use an info block or add a hint in the content field of a collection node to let your end-users know that they can provide multiple entries
❗ Known limitations
- Only up to 20 entries are allowed
- Formatting applied inside a collection block cannot be rendered in a database, the collection will appear as an unformatted string
- Email collections cannot be used to send bulk-emails
- Collections are excluded from CSV exports
- Auto-numbering cannot be applied currently
- Collections cannot be displayed as default options