Checkboxes Component

Overview

With a Checkboxes component, you can create a question with more than one possible answer. Checkboxes let your end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. choose more than one response from your provided options. Compare this to the Radio Buttons component, which only allows one selection. With Checkboxes, your end-user can compare all available options, selecting all that apply.

Here are some real-life examples of checkbox questions:

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.

You'll find the Checkboxes component in the Primary Fields group to the left of the Module Editor.

What You'll Learn

After completing this article, you’ll know when to use a Checkboxes component, how to configure its settings, and how to use it in an Unqork application.

About the Configuration Window

General

Setting	Description
Property ID	A Property ID is the unique field ID used by Unqork to track and link components in your module. The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls. Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation.
(ON)/ (OFF)	The component is active and visible in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View. While active, other components and processes can reference your component. Setting the toggle to (OFF) makes your component inactive. Other components and processes cannot reference your component while it's inactive. By default, the Active toggle is set to (ON).
Notes	Select this tab to display the component's Notes area. You can use notes to keep your teammates informed. The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component.
Display	Select this tab to manage your component's display settings.
Data	Select this tab to manage your component's data settings.
Actions	Select this tab to manage your component's actions settings.
Validation	Select this tab to manage your component's validation settings.
Advanced	Select this tab to manage your component's advanced settings.
Permissions	Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. (role-based access control) settings of the component.
Field Tags	Assign components one-word labels to help organize, identify, and group the components in your application. Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag. Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component. For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag. Save your Field Tags by pressing Enter (Return) or adding a comma after each entry.
Shortcuts	Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include: Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal. Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal. Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom. Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top. Enter (Return): When tabbing to a (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip. Additional keyboard shortcuts: Drop-down menus: When you Tab to a settings drop-down, use the keyboard's (up)/ (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.
Documentation	Select this tab to access the component documentation in Unqork's In-Product Help.
Cancel	Click this button to undo any unsaved configuration changes and return to the canvas.
Save & Close	Click this button to save all settings as configured and return to the canvas.

Display Panel

(click to expand image)

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 Toggle On Icon (ON), end-users can’t 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, the Disable User Input toggle is set to Toggle Off icon (OFF).

Hide Field

Shows or hides the component from view. Setting the Hide Field toggle to Toggle On Icon (ON) hides the component in Express View. Setting the toggle to Toggle Off icon (OFF) shows the component. The component is always visible in the Module Editor.

By default, the Hide Field toggle is set to Toggle Off icon (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

(click to expand image)

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 End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-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 Submission Data. Enter the values to store in Submission Data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label.

Setting

Description

Option Label

Each option needs an end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-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 Submission Data. Enter the values to store in Submission Data using this column.

By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label.

Data Reference Key

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.

Setting	Description
Data Reference Key	Enter the Property ID of the component that you're pulling data from.
Value Property	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 pull. If you're pulling from a Data Table component, enter the column header in this field.

Setting

Description

Data Reference Key

Enter the Property ID of the component that you're pulling data from.

Value Property

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 pull. If you're pulling 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 End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-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 Submission Data. Enter the values to store in Submission Data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label.
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.
Property Name of Existing Component	If you select the Choose Existing, you can enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. of an existing component in your module to trigger.
Selection to Uncheck All Options	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 End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-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 Submission Data. Enter the values to store in Submission Data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label. 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 End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-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. NOTE 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. NOTE 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. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help. TIP 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.

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 Toggle On Icon (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.

NOTE 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 Toggle Off icon (OFF) when you don’t want to store the values from this field in the database.

NOTE 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. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help.

TIP 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 Toggle On Icon (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Actions Panel

(click to expand image)

Triggers

Setting	Description
Trigger	To set up a trigger, enter the Property ID of your chosen logic component into this field. When the end-user performs an action on the current component, the triggered component fires.

Validation Panel

(click to expand image)

User Input

Setting	Description
Required	When set to (ON), the end user must enter a value in the component's visible fields. Set the toggle to (OFF) when an entry is optional. By default, the Required toggle 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.

Setting

Description

Required

When set to Toggle On Icon (ON), the end user must enter a value in the component's visible fields. Set the toggle to Toggle Off icon (OFF) when an entry is optional.

By default, the Required toggle is set to Toggle Off icon (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.

Advanced Panel

(click to expand image)

Setting	Description
Custom CSS Classes	Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. Class to apply to your component. Use custom CSS to maintain a consistent look and feel if the field or element is part of a template or more than one module. Updated CSS styling applies to all components that reference this custom class name.

Setting

Description

Custom CSS Classes

Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. Class to apply to your component. Use custom CSS to maintain a consistent look and feel if the field or element is part of a template or more than one module.

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

In the Module Editor, drag and drop a Single Checkbox component Icon

Checkboxes component onto your canvas.

In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter medicalHistory.

In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter Do you have, or have you had any of the following? Please check all that apply.

Set the Number of Columns as

(two columns).

From the component navigation menu, select Actions Icon

Data.

In the table under the Values Data Source Type, enter the following:

Option Label	Value to Store in Submission Data
Angina	angina
Asthma	asthma
Breathing Problems	breathingProblems
Chest Pains	chestPains
Diabetes	diabetes
Hay Fever	hayFever
High Blood Pressure	highBloodPressure
Rheumatism	rheumatism
Shingles	shingles
Ulcers	ulcers

Set the Selection to Uncheck All Options toggle to

(ON).

The Option Label stays set to None of the above. You can leave this as set or change it as needed.

The Value to Store in Submission Data stays set to None. You can leave this as set or change it as needed.

From the component navigation menu, select Actions Icon

Validation.

Set the Required toggle to

(ON).

10.

Click Save & Close.

11.

Save your module.

Preview your module in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View. You'll see the following functionality:

Structure of a Checkboxes Component's Data

A Checkboxes component stores its data as an array when viewed in the developer console.

Checkboxes Component

Overview

What You'll Learn

About the Configuration Window

General

Display Panel

Field Text

Default State Options

Contextual Help

Formatting

Data Panel

Data Source Types

Pre-Configured Checkbox Selections

Data Storage

Actions Panel

Triggers

Validation Panel

User Input

Advanced Panel

Adding a Checkboxes Component

Configure the Checkboxes Component

Structure of a Checkboxes Component's Data

Resources

Feedback

Sorry about that

Great!

Looking for more help?