0

Checklist

  • updated 1 mth ago

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. 

Sticky Editor Tabs

From v8 on, the part editor tab navigation is sticky in that whichever tab is active for the node you are inspecting/editing, when you click to another node, the same tab opens. This is helpful when you are making "mass changes", for instance adding mandatory validation to multiple nodes: select the validation tab, then as you click on each node to be edited, the validation tab automatically shows first.

Editor Fields

Field Name Description/Use Type/Options Optional/ Mandatory
Question 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.
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 The system records this text in the variable $(short_caption) so that it can ben displayed on screen (e.g. via the part/node template) or used elsewhere in the logicnet model.

Advanced Note:
The short logging caption cannot itself resolve any $(...) variables but in that event, 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 traversed (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:
  • _unanswered leg will be traversed when no checklist items are selected (this can be considered the default leg)
  • _answered leg will be traversed after ANY checklist item is selected (regardless of whether any validation rules)
This feature can be used in Assessment Framework applications to prevent subsequent questions from being shown after a checklist until the user provides at least one answer, in the same way that radiolists do (with route on output configured).

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: You create the options to display.
  • Collection: The system displays an editor with which you select the collection containing the items with which to create the checklist.
  • Table: The system displays an editor with which you can select a table in the project from which to create the checklist. This editor allows you to specify filters and column specifications to control the data set for the checklist.
Manual | Collection | Table data Mandatory
Options The system displays this table if you select "Manual" for the data location.
  • Value: Number and text. This is the stored value of the selected item.
  • Caption: Number and text. This is the caption the system shows next to the item. If this is empty, the system uses the "Value".
  • Weight: Number only. This is the specific item's weight the system assigns with this value. In v7.4, this is located on the Advanced tab.
  • Column: Number only. This field separates the items into different columns.
  • Condition: Number and text. This field makes the item visible if the item meets the specified condition. In v7.4, this is located on the Advanced tab. In v7.4.6 on this works the same was as for setting validation rules/conditions - see below.
  • References: Number and text. This field lets you attach a reference to the item with a clickable icon.
  • Speech command: Number and text. This is the alternative caption that is recognized by the speech component for selecting the item.
  • Options: Button. This is used to add, rename, and remove the item.
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

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:
  • mandatory: The user must enter a value.
  • custom: This allows you to set a custom condition.
  • Table count: This allows the user to provide a maximum of minimum amount of items that should be selected. The user has to specify the logical rule in the condition column. Examples:
    • '<5' - The system will display a validation warning when five or more options are selected.
    • '>3' - The system will display a validation warning when three or fewer options are selected.
    • '==2' - The system will display a validation warning when the number of selected options does not equal 2 exactly. Notice the double '=' here.
  • List all: The system will display a validation warning when not all options are selected.
  • List one or more: The system will display a validation warning when no option is selection.
Options Optional
Condition or Rule This is only required when type=custom.
  • (v7.4.6+) The preferred/simpler option to adding validations is to use the Rule option. This opens up the Rule Editor from where you can access the data model and build more sophisticated multi-element rules. See the article on the Rule node for more information on how to use this.
  • otherwise, type in any Conditions - see Setting Conditions (Data Validation) for more information on the syntax required.
  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
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
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
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, and the next two configuration options. 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
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. 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:

For some basic information on how clickable maps work in browsers, see this article.

Implementation Notes:

  • 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.

Examples

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).

Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular
Like Follow
  • 11 mths agoLast active
  • 194Views
  • 4 Following

Home