---
title: "Inputs Tab | ThreatConnect"
slug: "inputs-tab"
description: "This article describes the Inputs tab of the App Builder screen, including how to create and manage input parameters in an App project."
tags: ["Orchestration and Automation", "Developer Tools", "Markdown"]
updated: 2023-07-26T13:30:03Z
published: 2023-07-26T13:30:04Z
canonical: "knowledge.threatconnect.com/inputs-tab"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.threatconnect.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Inputs Tab

The **Inputs**tab (Figure 1) is where you can determine and manage an App’s input parameters (i.e., the fields that are viewed in the configuration pane for the App in the [Playbook Designer](/v1/docs/the-playbook-designer)).

![Graphical user interface, application, PowerPoint Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%201_Inputs%20Tab_7.2.0.png)

NoteYou can drag and drop this tab into a different area of the [**App Builder** screen](/v1/docs/the-app-builder-screen), if desired.

## Creating Input Parameters

To create a new input parameter, click the **+ NEW INPUT**button on the **Inputs**tab. The **Create Parameter:**drawer will be displayed on the left side of the screen (Figure 2).

![Graphical user interface, application, Teams Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%202_Inputs%20Tab_7.2.0.png)

- **Label**: Enter a name for the parameter. This is the name that will be displayed to users of the App.
- **Variable Name**: This field will autofill the name of the corresponding input variable for the parameter, based on the provided label. For example, if the label is “Sample Input Parameter”, then the **Variable Name**will fill as “sample_input_parameter”. This field may not be edited.
- **UI Element**: Use the dropdown list to select the type of element (**TextField**, **Editable Choice**, **Dropdown**, **Checkbox**, **Multiselect Dropdown**, or **Key/Value List**) that will render for this parameter in the **Edit App**pane in the **Playbook Designer**.NoteThe choice of UI Element will determine the rest of the fields that you can configure in the **Create Parameter:** section. For example, selecting **TextField**allows you to configure the **Default Value**, **Enable Multi-line**, **Data Type**, **Required**, **Hidden**, **Allow Text Variables**, and **Encrypted & Allow Keychain Variables** options, whereas selecting **Checkbox**allows you to****configure only the **Default Value** and **Hidden**options, and all remaining options will be grayed out.
  - **TextField**(Figure 2)
    - **Default Value**: Enter a default value that will be displayed for the parameter in the **Edit App** pane of the **Playbook Designer** when configuring the App, if desired.
    - **Enable Multi-line:**Select the checkbox to display a **TextField**input field with multiple lines in the **Edit App**pane of the **Playbook Designer**when configuring the App.
    - **Data Type**: Select one or more types of data that the parameter will take. These data types are the kinds of variables that users designing Playbooks that utilize the App will be allowed to enter. The letter to the left of each selection provides a quick reference to the type of data, with the array versions of a data type having the same letter as the non-array versions (e.g., both String and StringArray are represented by “S”), but appearing in a square instead of a circle.
    - **Required:**Select the checkbox to require users to enter a value for this parameter.
    - **Hidden**: Select this checkbox if the parameter should be a hidden parameter. A hidden parameter is a parameter that is not visible when configuring the App in a Playbook.
    - **Allow Text Variables**: Select the checkbox to allow text variables to be entered as values for this parameter.
    - **Encrypted & Allow Keychain Variables**: Select the checkbox to enable encryption and allow keychain variables to be entered as values for this parameter.
    - **Allow File Variables**: If **Binary**or **BinaryArray**is selected as the **Data Type**, then this checkbox will be displayed in place of the **Allow Text Variables** and **Encrypted & Allow Keychain Variables**checkboxes. Select this checkbox to allow file variables to be entered as values for this parameter. ![Graphical user interface, application, Teams  Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%203_Inputs%20Tab_7.2.0.png)
  - **Editable Choice**(Figure 3)
    - **Default Value:** Enter a default value that will be displayed for the parameter in the **Edit App** pane of the **Playbook Designer** when configuring the App, if desired.
    - **Dropdown Options:** Enter pipe-delimited (|) dropdown options that users will choose from in the **Edit App** pane of the **Playbook Designer** when configuring the App.
    - **Required:** Select the checkbox to require users to select a value for this parameter.
    - **Allow Text Variables:** Select the checkbox to allow text variables to be entered as values for this parameter. ![Graphical user interface, application  Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%204_Inputs%20Tab_7.2.0.png)
  - **Dropdown**(Figure 4)
    - **Default Value:** Enter a default value that will be displayed for the parameter in the **Edit App** pane of the **Playbook Designer** when configuring the App , if desired.
    - **Dropdown Options:** Enter pipe-delimited (|) dropdown options that users will choose from in the **Edit App** pane of the **Playbook Designer** when configuring the App.
    - **Required:** Select the checkbox to require users to select a value for this parameter. ![Graphical user interface, application, Teams  Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%205_Inputs%20Tab_7.2.0.png)
  - **Checkbox**(Figure 5)
    - **Default Value:** Specify whether the **Checkbox** parameter will be selected (**True**) or cleared (**False**) by default.
    - **Hidden**: Select this checkbox if the parameter should be a hidden parameter. A hidden parameter is a parameter that is not visible when configuring the App in a Playbook. ![Graphical user interface, application  Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%206_Inputs%20Tab_7.2.0.png)
  - **Multiselect Dropdown**(Figure 6)
    - **Default Value:**Enter a default value that will be displayed for the parameter in the **Edit App**pane of the **Playbook Designer**when configuring the App, if desired. Multiple values separated by the pipe (|) character may be entered as default values.
    - **Dropdown Options:** Enter pipe-delimited dropdown options that users will choose from in the **Edit App**pane of the **Playbook Designer**when configuring the App.
    - **Required:**Select the checkbox to require users to select a value for this parameter. ![Graphical user interface, application, Teams  Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%207_Inputs%20Tab_7.2.0.png)
  - **Key/Value List**(Figure 7)
    - **Data Type:** Select one or more types of data that the parameter will take. These data types are the kinds of variables that users designing Playbooks that utilize the App will be allowed to enter. The letter to the left of each selection provides a quick reference to the type of data, with the array versions of a data type having the same letter as the non-array versions (e.g., both String and StringArray are represented by “S”), but appearing in a square instead of a circle.
    - **Required:** Select the checkbox to require users to enter a value for this parameter.
    - **Hidden**: Select this checkbox if the parameter should be a hidden parameter. A hidden parameter is a parameter that is not visible when configuring the App in a Playbook.
    - **Allow Text Variables:** Select the checkbox to allow text variables to be entered as values for this parameter.
    - **Encrypted & Allow Keychain Variables:**Select the checkbox to enable encryption and allow keychain variables to be entered as values for this parameter.
    - **Allow File Variables**: If **Binary**or **BinaryArray**is selected as the **Data Type**, then this checkbox will be displayed in place of the **Allow Text Variables** and **Encrypted & Allow Keychain Variables**checkboxes. Select this checkbox to allow file variables to be entered as values for this parameter.
- **Help Note:**Text entered here will be displayed in the **Inputs**section of the **App Note**, which is the text that is displayed when **Display Documentation**![Icon  Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Playbooks_Display%20Documentation%20icon.png)is clicked in the **Edit App**pane of the **Playbook Designer**when configuring the App. To preview the note in Markdown, click the **Preview Markdown**link.
- Click the **CREATE**button to create the parameter.

The parameter will be displayed on the **Inputs**tab, along with letter representations of the data types it accepts (Figure 8).

![Graphical user interface, text, application Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%208_Inputs%20Tab_7.2.0.png)

Hovering over the parameter will display the **Insert Code****![Icon Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Insert%20Code%20icon_App%20Builder.png)**icon. To insert the parameter into the [**Code Editor**](/v1/docs/code-editor), position the cursor in the desired location in the **Code Editor**and click **Insert Code![Icon Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Insert%20Code%20icon_App%20Builder.png)**. For example, in Figure 9, the sample parameter was inserted on line 23.

ImportantThe **Insert Code![](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Insert%20Code%20icon_App%20Builder.png)**functionality employs [snippets](https://knowledge.threatconnect.com/docs/snippets-tab) to place input parameters into the **Code Editor**. Because snippets are available only to Apps that use TcEx 4.0.x, the **Insert Code**![](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Insert%20Code%20icon_App%20Builder.png)icon will not be displayed when you hover over an input parameter when working with Apps that use a TcEx version older than 4.0.x. In this scenario, you must manually write the code that references the input parameter in the **Code Editor** in order to use the parameter in the App. To determine an App's TcEx version, refer to the App's **requirements.txt** file located in the **[](https://knowledge.threatconnect.com/docs/contents-tab)**[](https://knowledge.threatconnect.com/docs/contents-tab)[**Contents**tab](https://knowledge.threatconnect.com/docs/contents-tab)[](https://knowledge.threatconnect.com/docs/contents-tab)**[](https://knowledge.threatconnect.com/docs/contents-tab)**.NoteYou can use your browser’s “undo” function (e.g., Command-Z) to remove a parameter that was erroneously inserted.

![Graphical user interface, text, application Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%209_Inputs%20Tab_7.2.0.png)

## Managing Input Parameters

Click the vertical ellipsis![](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Vertical%20ellipsis_Black.png)to the right of the parameter name in the **Inputs**tab to display options for editing or deleting the parameter.

### Editing Input Parameters

Select **Edit**to edit the parameter. The **Edit Parameter:**drawer will be displayed (Figure 10).

![Graphical user interface, application, Teams Description automatically generated](https://cdn.document360.io/dfc206c8-1c9f-4725-b74d-a66f83432320/Images/Documentation/Figure%2010_Inputs%20Tab_7.2.0.png)

- Make any desired changes to the parameter.
- Click the **CREATE**button.

NoteThe configuration options displayed in the **Edit Parameter:** drawer will reflect the UI Element selected when the parameter was created. See Figures 2–7 for the configuration options for an **Editable Choice**, **Dropdown**, **Checkbox**, **Multiselect Dropdown**, and **Key/Value List** parameter, respectively.

### Deleting Input Parameters

Select **Delete**to delete the parameter. If code for an input parameter has been inserted into the **Code Editor** and then the parameter is deleted, the inserted code will remain.

---

*ThreatConnect® is a registered trademark of ThreatConnect, Inc.*

20084-10 v.07.B
