Do you have any of the following medical conditions? Please select all that apply.
What sports do you play on a regular basis? Please select all that apply.
Which of these account types are you interested in opening? Please select all that apply.
The Checkboxes component has built-in Select All and None of the Above options. This adds more versatility to your application and prevents conflicting responses.
You can also use a Checkboxes component to trigger a Text Field component to display. Think of this as a write-in option for your end-user. For example, if none of the provided answers apply, they can select the Other box, which displays a separate text field. That way, your end-user can enter their response.
A Checkboxes component can also trigger an existing component. For example, an end-user who wants to open an account can select Retirement from a list of options. When they select the Retirement box, a new drop-down displays to select a specific account type.
To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.
Display Panel
Field Text
Setting
Description
Property ID
A Property ID is the unique field ID used by Unqork to track and link components in your module.
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.
User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.
Contextual Help
Setting
Description
Tooltip
A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.
Helper Text
A quick tip describing the expected value of an input field. Unlike a Tooltip, Helper Text stays visible under the input field and displays on a single line.
Default State Options
Setting
Description
Disable User Input
When set to (ON), end-users cannot interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change.
By default, Disable User Input is set to (OFF).
Hide Field
Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder.
By default, Hide Field is set to (OFF).
Formatting
Setting
Description
Number of Columns
The number of columns in which you want the checkboxes evenly arranged. You have the option of (one), (two), or (three) columns.
By default, the checkboxes align on a single column.
Data Panel
Data Storage
Setting
Description
Store Data in Database
The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:
Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.
Triggering a module save event using a Button component with an Action Type of Save.
Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.
By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.
Set the toggle to (OFF) when you don’t want to store the values from this field in the database.
When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response.
Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.
Promote Data to Top Level
When set to (ON), the component's values store at the highest level of the submission data. Use this if you need responses to read true or false for each option instead of one list of all items selected.
When set to (OFF), values store as one string containing all selected items.
By default, the Promote Data to Top Level toggle is set to (OFF).
Data Source Type
There are two methods that you can use to populate a Checkboxes component: Values or a Data Reference Key.
Values
Values are the simplest way to populate a Checkboxes component. When selecting the Values setting, a Values table displays. Click the Edit button to open the Values table and enter each checkbox option with its associated value.
Setting
Description
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
Value to Store in Submission Data
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.
With a Data Reference Key, you can use data from another component to populate your Checkboxes component. You'll most often use a Data Table component. Add your data to the Data Table and then reference it in your Checkboxes component's configuration menu.
Think of this as a hybrid when using Values and Data Collection to populate your Checkboxes component. You still use data stored in Unqork, but it's data from your module instead of a Data Collection.
If a data set includes a column for values, enter the column's name here.
If not specified, the application uses the data drawn using the Label Path setting below.
Label Path
This field refers to the option labels to retrieve. If you're retrieving data from a Data Table component, enter the column header in this field.
Pre-Configured Checkbox Selections
Setting
Description
Selection to Trigger a Component
When set to (ON), you can add an option that triggers another component when selected. This is useful if you want the end-user to give a custom response or to elaborate on a response. This new option displays at the bottom of the list.
By default, the Selection to Trigger a Component toggle is set to (OFF).
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
By default, the Selection to Trigger a Component has the Option Label of Other.
Value to Store in Submission Data
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.
Component to Trigger When a User Selects This Option
Here you have the choice of triggering a new Text Field component or an existing component to display below the associated checkbox option.
Text Field: This option creates a new text field so the end-user can enter a separate entry. For example, your Checkboxes component might contain a list of medical conditions. If an end-user's condition isn't on the list, they can click Other and enter it.
Choose Existing: This option connects an existing component to a checkbox option. Again, your Checkboxes component might contain a list of medical conditions. For example, if an end-user's condition isn't on the list, they can click Other. You can set this to trigger a hidden Dropdown component containing an expanded list of conditions.
Property Name of Text Field
If you select the Text Field option, you must give the new Text Field component a Property Name.
Placeholder of Text Field
If you select the Text Field, you can enter a placeholder text to assist the end-user.
This setting adds a new checkbox (None of the Above) that, when selected, clears all other options. With None of the Above selected, the end-user cannot make any other selections. To make another selection, they must clear None of the Above.
By default, the Selection to Uncheck All Options toggle is set to (OFF).
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
By default, the Selection to Uncheck All Options has the Option Label of None of the Above.
Value to Store in Submission Data
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.
By default, the Selection to Uncheck All Options has a value of None.
Selection to Select All Options
This setting adds a new checkbox (Select All) that, when selected, selects all other options. This option automatically excludes the None of the Above option, if applicable.
By default, the Selection to Select All Options toggle is set to (OFF).
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
By default, the Selection to Select All Options has the Option Label of Select All.
You can set specific parameters apart from requiring the field. For example, you might only allow your end-user to select two items from the list. If they select a third item, this custom error message displays.
User Input
Setting
Description
Required
When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.
By default, Required is set to (OFF).
Required Error Message
A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.
Do you have any of the following medical conditions? Please select all that apply.
What sports do you play on a regular basis? Please select all that apply.
Which of these account types are you interested in opening? Please select all that apply.
The Checkboxes component has built-in Select All and None of the Above options. This adds more versatility to your application and prevents conflicting responses.
You can also use a Checkboxes component to trigger a Text Field to display. Think of this as a write-in option for your end-user. For example, if none of the provided answers apply, they can select the Other box, which displays a separate text field. Then, they can enter their response.
A Checkboxes component can also trigger an existing component. For example, an end-user who wants to open an account can select Retirement from a list of options. When they select the Retirement box, a new drop-down displays. Here, they can select a more specific account type.
To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.
Display Panel
Field Text
Setting
Description
Label Text
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.
User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.
Default State Options
Setting
Description
Disable User Input
When set to (ON), end-users cannot interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change.
By default, Disable User Input is set to (OFF).
Hide Field
Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder.
By default, Hide Field is set to (OFF).
Contextual Help
Setting
Description
Tooltip
A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.
Helper Text
A quick tip describing the expected value of an input field. Unlike a Tooltip, Helper Text stays visible under the input field and displays on a single line.
Formatting
Setting
Description
Number of Columns
The number of columns in which you want the checkboxes evenly arranged. You have the option of (one), (two), or (three) columns.
By default, the checkboxes align on a single column.
Data Panel
Data Source Types
There are two methods that you can use to populate a Checkboxes component: Values or a Data Reference Key.
Values
Values are the simplest way to populate a Checkboxes component. When you select Values, a Custom Checkbox Selections table displays. In this table, enter each checkbox option and its associated value.
Setting
Description
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
Value to Store in Submission Data
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.
With a Data Reference Key, you can use data from another component to populate your Checkboxes component. You'll most often do this with a Data Table component. Add your data to the Data Table and then reference it in your Checkboxes configuration window.
Think of this as a hybrid of using Values and Data Collection to populate your Checkboxes. You still use data stored in Unqork, but it's data from yourmodulerather than a Data Collection.
If a data set includes a column for values, enter the column's name here.
If not specified, the application uses the data drawn using the Label Path setting below.
Label Path
This field refers to the option labels to retrieve. If you're retrieving data from a Data Table component, enter the column header in this field.
Pre-Configured Checkbox Selections
Setting
Description
Selection to Trigger a Component
When set to (ON), you can add an option that triggers another component when selected. This is useful if you want the end-user to give a custom response or to elaborate on a response. This new option displays at the bottom of the list.
By default, the Selection to Trigger a Component toggle is set to (OFF).
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
By default, the Selection to Trigger a Component has the Option Label of Other.
Value to Store in Submission Data
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.
Component to Trigger When a User Selects This Option
Here you have the choice of triggering a new Text Field or an existing component. The triggered Text Field or component displays below the associated checkbox option.
Text Field: This option creates a new Text Field where the end-user can enter a separate entry. For example, your Checkboxes component might contain a list of medical conditions. If an end-user's condition isn't on the list, they can click Other and enter their condition.
Choose Existing: This option connects an existing component to a checkbox option. Again, your Checkboxes component might contain a list of medical conditions. For example, if an end-user's condition isn't on the list, they can click Other. You can set this to trigger a hidden Dropdown containing an expanded list of conditions.
Property Name of Text Field
If you select the Text Field option, you must give the new Text Field component a Property Name.
Placeholder of Text Field
If you select the Text Field, you can enter a placeholder text to assist the end-user.
This setting adds a new checkbox (None of the Above) that, when selected, clears all other options. With None of the Above selected, the end-user can't make any other selections. To make another selection, they must clear None of the Above.
By default, the Selection to Uncheck All Options toggle is set to (OFF).
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
By default, the Selection to Uncheck All Options has the Option Label of None of the Above.
Value to Store in Submission Data
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.
By default, the Selection to Uncheck All Options has a value of none.
Selection to Select All Options
This setting adds a new checkbox (Select All) that, when selected, selects all other options. This option automatically excludes the None of the Above option, if applicable.
By default, the Selection to Select All Options toggle is set to (OFF).
Option Label
Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.
After you create an option, another row displays for you to create the next option.
By default, the Selection to Select All Options has the Option Label of Select All.
Data Storage
Setting
Description
Promote Data to Top Level
When set to (ON), the component's values store at the highest level of the submission data. Use this if you need responses to read True or False for each option instead of one list of all items selected.
When set to (OFF), values store as one string containing all selected items.
By default, the Promote Data to Top Level toggle is set to (OFF).
Store Data in Database
The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:
Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.
Triggering a module save event using a Button component with an Action Type of Save.
Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.
By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.
Set the toggle to (OFF) when you don’t want to store the values from this field in the database.
When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response.
Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.
When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.
By default, Required is set to (OFF).
Required Error Message
A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.
Updated CSS styling applies to all components that reference this custom class name.
Adding a Checkboxes Component
Now, let's create an application that will collect the medical history of an applicant. These instructions assume that you have an open modulesaved with a title.
Configure the Checkboxes Component
1.
In the Module Builder, drag and drop a Checkboxes component onto your canvas.
(
(one), 
(three) columns. 
Checkboxes component onto your canvas.
(two columns).
(ON), the component's values store at the highest level of the submission data. Use this if you need responses to read True or False for each option instead of one list of all items selected.
Data
Validation
