What is a Checkbox input

Checkbox input is an input component that allows you to enter a checkbox for boolean (i.e. True/False) values.

When to use the Checkbox input component

The Checkbox input component is suitable for an entry showing a binary situation (e.g. True/False, Selected/Unselected).

How to add a Checkbox input to my custom Tool

The Checkbox component is listed under User inputs. You can add it to your Tool using the main section or the side-bar.


Checkbox input setting

  1. Title: the title of your input component
  2. Description: To describe what this input is or will be used for, etc.
  3. Variable name: located on the bottom left and marked in green, you can rename the variable and use the name to access the data in your Tool
  4. Optional/Required: located on the top right, as the name suggests, unlike an optional component, a required components must be provided before your analysis starts.

Input setting

Set a default value

To set a default value for an input component, enter the value and click on the small setting icon on the bottom right. Next click on Set current value. Set default value

Access the value

To access the entered data use the variable mode {{}} and the input step name. Under the default setting it is accessible via {{checkbox}} (or params.checkbox in a JavaScript step).