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.
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.
|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.
|Yes | No||Optional|
|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||This is the text the system displays at the bottom of the checklist control.||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|
|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.
|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|
Validate Tab Options
|Type||This allows you to have the system trigger the display of an error message based on parameters you define:
|Condition||This is only required when type=custom--when the user has set a custom validation parameter. It tells the system under which condition to display a validation message. See Setting Conditions article for more information.||Optional|
|Message||This is the message the system displays to the end-user if a validation rule is not met. The system displays the message associated with the first violated rule.||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|
Advanced Tab Options
|Display Label Options||This field is used to show which values can be assigned by the call node (Calculator Call) object. The result of the call node must be only one of the value on the list.
Value: The system passes the value by "Calculator Call".
Display Label: This is the text you want to display on the label for each value. If you leave this empty the system displays the "Value" on the screen.
|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
Clickable Image Maps
For Release 7.4.5 onwards, 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. An example project shows a human body map with clickable areas for heart, lungs, etc. The options can be shown or hidden from view.
For help laying out the clickable areas, there are several free tools available on the internet, including:
- https://imagemap.org/ (good for creating simple image maps) or
- https://summerstyle.github.io/summer/ (more sophisticated tool for intricate shapes, PLUS the ability to load a set of coordinates and edit).
For some basic information on how clickable maps work in browsers, see this article.
- Clickable areas should not overlap. Take care to draw the map coordinates accurately.
- Only one fully enclosed area can be defined for each answer option.
- Depending on the image, leave space between areas so the user can easily tell which part of the image is selected.
- Clickable areas will show with a change in mouse style.
- When hovering over a clickable area, the system shows the caption for that answer option as a tooltip.
For an example of how to use the checklist part, download and import this project in your workspace.
Clickable Image Example
Download and import this second example project to see the human body as a clickable map supporting a radiolist choice (you can change the radiolist to a checklist using the dropdown at the top of the part editor).