0
Checklist
Description
The Checklist part allows you to create a checkbox list in a form or with a form-part, allowing your application's users to select one or multiple items from a list of options.
Use
For projects created without a framework you can add a checklist control in a page using the checklist part in the toolbar. In the Designer, add a form node and the system opens the form node editor. In the form node editor, with your cursor in the HTML editor in the location where you want the system to add the checklist, select the "insert checkbox list" option from the toolbar. The system adds the checklist and displays the checklist part editor.
For projects using a framework, you can create form-part nodes that contain the checklist part. Add a Checklist form-part node. The checklist part associated with frameworks contain additional parameters for controlling functionality specific to the framework. Depending on the project framework you selected, you can modify the way the system creates the checkbox list: adding options, passing the selected option to a variable, and storing the selections.
NOTE: You should not use the following words in the data object name: and, break, do, else, elseif, end, false, for, function, if, in, local, nil, not, or, repeat, return, then, true, until, while, type. You should also never start a data object name with a number.
Tips and Tricks
Reordering Options
As of v8+, you can easily reorder manually entered options in a radiolist, dropdown, or checklist by dragging the row up or down. Using your mouse, click and hold the left-most column indicator, move it to the desired placement, and release.
Editor Fields
Basic Tab Options
| Field Name | Description/Use | Type/Options | Optional/Mandatory |
| Type (v7.4+) |
This field defaults to the specific form part you selected from the Nodes Toolbox; for example, a radio list. However, you can use this field to quickly change the type of form part without having to recreate answer options. If you first created your question and a checklist, for example, but realize it should be a radio list, use this field to select an alternative question type, and click save. The system transfers the key parameters into the new question type. Parameters specific to the question type (e.g. top choice for dropdown) remain in the configuration, and will be redisplayed if you convert the form part back to your original selection. Making this change may trigger some validation warnings, which you can address as necessary. WARNING: When converting a radio list with "Route on Output" to a checklist, remove the Route on Output flag prior to converting your part or remember to connect the checklist with the next node using a standard link (not one that says "default" or a specific answer option). When switching from a checklist to dropdown, the data type stays set to collection, which results in the dropdown allowing multiple values. To force the user to select only one value from the dropdown list, change the data type to text or number based on the answer options. |
Radiolist Checklist Dropdown |
Mandatory |
| HTML enabled | When this is enabled you can put HTML formatting in the Question caption, which means the system will display HTML tags in the text in the caption editor as they would appear in a browser. The editor browser provides limited HTML editing options for text formatting. You can toggle the HTML-enabled button on and off to alternate between seeing and editing tags and displaying them as they will appear. | Yes | No | Optional |
| Question | This is the text the system displays next to the checklist selections. | Text | Mandatory |
| Short Caption | The system records this text in the variable $(short_caption) so that it can be displayed on screen using the part/node template or used elsewhere in the logicnet model. Advanced Note: The short logging caption cannot itself resolve any $(...) variables, but you can use $(_.meta.short_caption) instead. This pulls the short_caption from the data log, which means the question has to be active (not disabled) and the field is only populated once the question appears on screen. |
Text | Optional |
| Data object | This is where the system stores the result of the user's selection from the checklist. | Data Object | Optional |
| Caption object | This is where the system stores the caption that belongs to the result of the user's selection from the checklist. This is useful in case you choose different fields from the checklist option to show as caption and to store as value. | Data Object | Optional |
| Submit on select | If you check this box, the system submits the form when the user makes a checkbox selection. If the checklist is being used with a framework and this checkbox is checked, the system submits the form when the user makes a selection and the system executes parallel and downstream steps. | Yes | No | Optional |
| Route on output (v8+) |
If you check this box, the node has TWO outputs that can be connected to different downstream nodes:
Unchecking the route on output feature will update the node with ONE output leg that is traversed regardless of any user input or otherwise. |
Yes | No | Optional |
| Weight | If the user provides a number in this field, the system will assign the associated weight to the selected value. | Number | Optional |
| Speech command | If speech recognition is enabled, this is the recognized command the system will use to identify the checklist component so its individual items can be specified. | Text | Optional |
| Item type | This is the type of items comprising the checklist. | Text | Number | Mandatory |
| Data location | This is where the system will get the items to display as a checklist.
|
Manual | Collection | Table data | Mandatory |
| Options | The system displays this table if you select "Manual" for the data location.
|
Table | Mandatory |
| Display options horizontally | By default, the system displays all options in a vertical list. If you enable this option the system displays the options horizontally. | Yes | No | Optional |
| Maximum amount of columns | This allows you to set the maximum number of columns the system will use to display the items. | Number Selection | Optional |
Validate Tab Options
| Field Name | Description/Use | Type/Options | Optional/Mandatory |
| Type | This allows you to have the system trigger the display of an error message based on parameters you define:
|
Options | Optional |
| Condition or Rule | This is only required when type=custom.
|
Optional | |
| Calculator Call (v7.4+) | This field is used to receive the result of the checklist from a call node. | Call Logicnet | Optional |
| Display link text (v7.4+) | This field is used to show the result of the call node with a specific text. | Data object | Text | Optional |
Style Tab Options
See the Style Tab Options article for more information about these settings.
Advanced Tab Options
| Field Name | Description/Use | Type/Options | Optional/Mandatory |
| Captions | This allows you to specify different captions based on rules. The system only displays one caption, the last caption in the table the rule determines to be true. If there is no rule the system determines to be true, the system uses the 'standard' caption. For an example, see Multi-Caption Example Project. | Text | Optional |
| Disable logging | Click this checkbox to disable logging. | Checkbox | Optional |
| Hide when empty (when there are no answer options) (v7.4.5+) |
For use with an image map, click this checkbox for the system will display the radio list question and image, but not the options. | Checkbox | Optional |
| Use Image map (v7.4.5+) |
If you click this checkbox, the system will open a image selection field that allows you to select an image from your resources/images folder. When a user accesses your application, the system displays the selected image between the radio list question and selection options. See below for more information. | Checkbox | Optional |
| Show Check-all (v8.1+) |
Option to add checkbox/clickable text (customizable) to allow the user to select all (or deselect all) items in the list. See this detailed article for more information on this and the next two related configuration options below. | Checkbox | Optional |
| "Check-all" text | Text displayed when the user can click to select all items (only available when Show Check-All is checked) | Text | Optional |
| "Uncheck-all" text | Text displayed when the user can click to deselect all items (only available when Show Check-All is checked) | Text | Optional |
| Options/Exclusive | Use this to set items in the checklist as "exclusive", meaning if the user selects this option the system deselects the other options. | Checkbox | Optional |
| Disable input expression (v7.4.6+) |
Use this to disable the input (prevents the user from editing/changing the selected option) based on the value of another variable by entering $(...) here. Otherwise this will reflect the "Disable Input" checkbox setting in the STYLE tab (1 for disabled, 0 for enabled). | Text | Optional |
| Processing Mode (v7.4+) |
The default behavior is Always use form value, which takes the user input or on-screen value, including "not answered", and assigns it to the data object. If an earlier answer/pathway combines to set a later on-screen variable, choose Use ctx for this data object to display the context value. This value can always be overwritten by user input. |
Always use form value | Use ctx when form value empty |
Mandatory |
Clickable Image Maps
With v7.4.5+, Designer Users can utilize an image map with defined areas to act as an input (either radiolist or checklist). When clicking on an area (can be a rectangle, circle, or multi-point polygon), the click is translated into the selection of an answer option. See this article for more information.
Examples
For an example of how to use the checklist part, download and import this project in your workspace.
Like
Follow
Reply