1. Checkbox
  2. Knowledge Base
  3. Studio Blocks
  4. Question Blocks

LIST Block

SKIP AHEAD TO
What do LIST blocks do?
What are LIST variables used for?
How to add and configure a LIST block
How to show LIST size

 

What do LIST blocks do?

LIST blocks prompt the end user to provide a list of entries. This list can then be referenced through the LIST variables. Learn more on referencing variables.

LIST blocks are also used along with the LOOP block where for each entry in a paired list, the pages in the Loop are run through once. Learn more about LOOP blocks.

 

What are LIST variables used for?

LIST variables can be referenced to:

  1. Display a list of all entries the user has entered

    Data_Capture_Section_V2_2020-10-22_11-43-21.png


  2. Create dynamic table rows inside a TABLE block. Learn more.
  3. Create dynamic table rows with a LOOP function inside a rich style document template. Learn more.

Budgeting_Report_Example_Template_2_2020-09-11_11-26-34.png

 

How to add and configure a LIST block

  1. Drag in a LIST block from the left panel and connect it to the other blocks

  2. Add Header under the “Header” field and a question or prompt inside the textbox (i.e. rich text editor) on the right panel in the Property Editor to help the end user insert the correct values in the list

    Note: It is best practice to bold the questions/prompt similar to when formatting questions in Paragraph fields of FORM blocks.

    For example, in a budgeting tool, you may want to prompt the end user to enter their expense items. Therefore the added Header is “List of Expense Items” and the added prompt is “Please list your items of expenditure”. See below screenshot.

Data_Capture_Section_V2_2020-10-22_11-45-21.png

3. [Optional] You can use the "Disable BACK button" toggle to prevent users from accessing any pages before this block. Turning this toggle ON will hide the "BACK" button on this page, as well as prevent the end-user from navigating back via the transcript. Any route backs returning to pages before this block will continue to work.

 

Disabling the back button is useful in the following cases:

    1. You have an integration before this block, and you want to prevent users from accidentally triggering it twice
    2. You have email(s) before this block, and you want to prevent users from accidentally triggering it twice
    3. You're presenting some outcome to the end-user, and want to prevent them from returning to previous pages and changing their answers
    4. You've reached the end of the app, and would like to prevent the user from modifying their submissionblobid1.jpgAn example of the "Disable BACK button" toggle on a FORM block. This feature is also available on the List, Yes/No, Table, Transcript, Doc Review and End blocks.

How to show LIST size

You can write conditions to create logic based on the number of values (entries) in a list using the operator LIST_SIZE. The below examples illustrate some of the different ways you could reference LIST_SIZE when writing conditions to create logic in Checkbox.

Scenario Logic
If there are no values in LIST123. LIST123_SIZE < 1
If there is only one entry in LIST123. LIST123_SIZE == 1
If there is more than one entry in LIST123. LIST123_SIZE > 1


Essentially, the LIST_SIZE variable is a number output and can be referenced and used with Operators as you would for a numerical value.

Please note LIST variables have a limit 1000 items. 


Related Articles: