Single Checkbox Component

Estimated Reading Time:  10 minutes

Overview

The Single Checkbox component presents 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. with a single option for selection. Here are some real-life examples of when to use a Single Checkbox:

  • Select this checkbox to confirm you are at least 18 years old.

  • I've read and agree to the terms of use.

  • Shipping Address is the same as Billing Address.

You can set a checkbox as required or leave it optional. You might require the checkbox if you want the end-user's consent before they proceed. For example, use a required checkbox for Age Verification and Terms of Use consent.

You can also set a checkbox to trigger an action. Take the above example of Shipping Address is the same as Billing Address. A field might autofill with the end-user's shipping information if they select the checkbox.

You can find the Single Checkbox component in the Primary Fields group to the left of the Module Builder.


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

About the Configuration Window

General

A static image of the Single Checkbox component's configuration window.

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.

Toggle On Icon (ON)/Toggle Off icon (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 Toggle Off icon (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 Toggle On Icon (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 Icon Display

Select this tab to manage your component's display settings.

Data Icon Data

Select this tab to manage your component's data settings.

Actions Icon Actions

Select this tab to manage your component's actions settings.

Validation Icon Validation

Select this tab to manage your component's validation settings.

Advanced Icon Advanced

Select this tab to manage your component's advanced settings.

Permissions Icon 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 Tag Icon 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 Icon 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 Icon (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-Arrow Icon (up)/ Down-Arrow icon (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.

Documentation IconDocumentation

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

A static image dispaying the Single Checkbox component's Display settings.
(click to expand image)

Field Text

Setting

Description

Label Text

Canvas 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

Hide Label

Setting the Hide Label toggle to Toggle On Icon (ON) stops Label Text from displaying in Express View. Your Label Text still displays in the Module Builder.

By default, the Hide Label toggle is set to Toggle Off icon (OFF).

Read Only View

When set to Toggle On Icon (ON), the component is display-only. If another component pushes content to the field, the end-user sees that content. Otherwise, end-users see the word None.

By default, the Read Only View toggle is set to Toggle Off icon (OFF).

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

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 Questionmark Icon (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

Set Default Value to Checked

When set to Toggle On Icon (ON), the checkbox is selected by default.

By default, Set Default Value to Checked set to Toggle Off icon (OFF).

Data Panel

A static image dispaying the Single Checkbox component's Data settings.
(click to expand image)

Data Storage

Setting

Description

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.

By default, the Store Data in Database toggle is set to ON.

NOTE  If your end-user never selects the box, the value stores as null. If your end-user selects the box, the value stores as True. And if your end-user clears the box again after selecting it, the value stores as False.

Actions Panel

A static image dispaying the Single Checkbox component's Actions settings.
(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

A static image dispaying the Single Checkbox component's Validation settings.
(click to expand image)

User Input

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

A static image dispaying the Single Checkbox component's Advanced settings.
(click to expand image)

Additional Styling

Setting

Description

Custom CSS Class

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 Single Checkbox Component

Configure a Single Checkbox component that asks 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. to acknowledge a set of terms and conditions. Then configure a Decisions component to display a button if the end-user agrees to the conditions.

These instructions assume that you have an open module saved with a title, and a Content or HTML Element component set up with an agreement.

What You Need

In this configuration, you need the following components:

Configure the Single Checkbox Component

Set the checkbox as Required to stop the end-user from proceeding until they select the it.

1. In the Module Builder, drag and drop a Single Checkbox component Icon Single Checkbox component onto your canvas.
2. 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 agree.
3. In the Label Text field, enter Select this box if you agree to the terms and conditions.

A static image displaying the Single Checkbox component's configuration window. The Label Text field is highlighted.

4. Click Actions Icon Actions.
5. In the Trigger field, enter ruleAgree. This triggered component is configured in a later step.
6. Click Validation Icon Validation.
7. Set Required to Toggle On Icon (ON).

A static image displaying the Single Checkbox component's Actions and Validation settings. The trigger is set to ruleAgree and the Required setting is toggled on.

8. Click Save & Close.

Configure the Decisions Component

The Decisions component is triggered by the Single Checkbox component to make the btnSubmit Button component visible. Add Booleans (true/false) in the MicroDecisions table to hide the Button component when the end-user clears the Single Checkbox component.

1. Drag and drop a Decisions component Icon Decisions component onto your canvas, placing it below the agree Single Checkbox component Icon Single Checkbox component.
2. 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 ruleAgree.
3. In the Canvas Label Text field, enter ruleAgree.
4. Click Actions Icon Actions.
5. In the Inputs table, enter the following:
  Property ID Alias Type Required Silent

1

agree

 

exact

Checked Box icon (Checked)

☐ (Unchecked)
6. In the Outputs table, enter the following:
  Property ID Type

1

btnSubmit

visible
7. In the Micro Decisions table, enter the following:
  Input Values Output Values
  agree btnSubmit_visible

1

true

 yes

2

false

no

A static image displaying the Decisions component's Actions settings, the Inputs, Outputs, and Micro Decisions tables are filled out.

8. Click Save & Close.

Configure the Button Component

Add a Button component, so end-users can save their submission only if they agree to the terms and conditions. Use the Hide Field setting to prevent users from saving before they check the agree Single Checkbox component Icon Single Checkbox component.

1. Drag and drop a Button component Icon Button component onto your canvas, placing it below the ruleAgree Decisions component Icon Decisions component.
2. 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 btnSubmit.
3. Set Hide Field to Toggle On Icon (ON).
4. Click Save & Close.
5. Save your module.

Once implemented, your Single Checkbox looks like the following 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:

Structure of a Single Checkbox Component's Data

The data structure of a Single Checkbox selection is a key/value pair. The key is the Property ID name of the component, and the value is stored as a Boolean value.

A static image displaying the data structure of a Single Checkbox component as seen a browser's Developer Console.

Resources