Text input

​

What is a Text input

Text input is an input component that allows you to enter a line of text. The value can be entered by the user or later fetched from an uploaded dataset (bulk-run).

​

When to use the Text input component

The Text input component is suitable for short pieces of text. Such as a question, name, topic, etc.

​

How to add a Text input to my custom Tool

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

​

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

​

Access the entered text

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