> For the complete documentation index, see [llms.txt](https://help.bioinsight.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.bioinsight.illumina.com/connected-analytics/project-web-ui/p-flow/pipelines-new-view/json-based-input-forms/inputform-json.md). # inputForm.json ## inputForm.json The JSON schema allowing you to define the input parameters. See the [JSON Schema](/connected-analytics/project-web-ui/p-flow/pipelines-new-view/json-based-input-forms/inputform-json/inputform.json-syntax.md) page for syntax details. {% hint style="info" %} The inputForm.json file has a size limit of 10 MB and a maximum of 200 fields. {% endhint %} ## Field types

Type	Usage
checkbox	A true/false checkbox that supports the option of being required, for example when you want the checkbox checked to accept the terms of use. This is done by setting minValues is to 1. (corresponds to the booleanType in xml).
data	Data such as files. The optional nameFilter is a data filename filter pattern for parts of the expected filename.
disclosureSection	The disclosure section is an expandable section containing fields which can be used to hide seldom used options in the input form. The fields in this section are always validated, even if it is collapsed. Supported attributes are id, type, label, helpText, tooltipText, value, hidden and updateRenderOnChange
featureSection	Feature sections are preceded by a checkbox. When the checkbox is checked, the section expands to show the fields inside the section and their content is validated. When the checkbox is unchecked, the section collapses and the fields inside the section are not validated. This type is best suited for toggling a feature or step in a pipeline on or off. FeatureSections can contain disclosureSections. Supported attributes are id, type, label, helpText, tooltipText, value, hidden, updateRenderOnChange and disabled.
fieldgroup	Can contain parameters or other groups. Useful for building complex data structures. Can have repeating sets of parameters, for instance when a father/mother/child choice needs to be linked to each file input. So if you want to have the same elements multiple times in your form, combine them into a fieldgroup. Fieldgroups do not support the emptyValuesAllowed attribute.
integer	Corresponds to java Integer. Supports min and max values.
number	The value is of Number type in javascript and Double type in java. (corresponds to doubleType in xml).
radio	A radio button group to select one from a list of choices. The values to choose from must be unique.
section	For splitting up fields, to give structure to the form. Rendered as subtitles. No values are to be assigned to these fields.
select	A dropdown selection to select one from a list of choices. This can be used for both single-level lists and tree-based lists. A choice entry set to disabled can be helpful to build the hierarchy tree without being selectable.
text	To display informational messages. No values are to be assigned to these fields.
textbox	Corresponds to stringType in xml. Supports regex and length limitations.

## Field Parameter Attributes These attributes can be used to configure the fields.

Attribute	Purpose
choices	A list of choices with for each a value, text (is label), selected (only 1 true supported), disabled. parent can be used to build hierarchical choice trees. availableWhen can be used for conditional presence of the choice based on values of other fields. Parent and value must be unique, you cannot use the same value for both.
dataFilter	For defining the filtering when type is 'data'. Use nameFilter for matching the name of the file, dataFormat for file format and dataType for selecting between files and directories. (To see the data formats, open the file details in Platform Core and look at the Format on the data details. You can expand the dropdown list to see the syntax.) The dataType="file" also accepts S3 and HTTP(S) URLs.
disabled	Shows the parameter but makes editing it impossible. The value can still be altered by onRender.js.
dropValueWhenDisabled	When this is present and true and the field has disabled being true, then the value will be omitted during the submit handling (on the onSubmit result).
emptyValuesAllowed	When maxValues is 1 or not set and emptyValuesAllowed is true, the values may contain null entries. Default is false.
fields	The list of sub fields for type fieldgroup.
helpText	A helper text about the parameter. Will be displayed in smaller font with the parameter.
hidden	Makes this parameter hidden. Can be made visible later in onRender.js or can be used to set hardcoded values of which the user should be aware.
label	The display label for this parameter. Optional but recommended, id will be used if missing.
max	Maximal allowed value for 'integer' and 'number' type. for 'integer' type fields the minimal and maximal values are -100000000000000000 and 100000000000000000. for 'number' type fields the max precision is 15 significant digits and the exponent needs to be between -300 and +300.
min	Minimal allowed value for 'integer' and 'number' type. for 'integer' type fields the minimal and maximal values are -100000000000000000 and 100000000000000000. for 'number' type fields the max precision is 15 significant digits and the exponent needs to be between -300 and +300.
maxValues	The maximal amount of values that need to be present. Default when not set is 1.
minValues	The minimal amount of values that needs to be present. Default when not set is 0. Set to >=1 to make the field required.
minMaxValuesMessage	The error message displayed when minValues or maxValues is not adhered to. When not set, a default message is generated.
maxLength	Only applied on type="textbox". Value is a positive integer.
minLength	Only applied on type="textbox". Value is a positive integer.
placeHolderText	An optional short hint ( a word or short phrase) to aid the user when the field has no value.
regex	The regex pattern the value must adhere to. Only applied on type="textbox".
regexErrorMessage	The optional error message when the value does not adhere to the "regex". A default message will be used if this parameter is not present. It is highly recommended to set this as the default message will show the regex which is typically very technical.
tooltipText	An optional HTML markdown-formatted text describing detail what the user is expected to enter in the field. This text is displayed when selecting the (i) icon next to the field and is avaialble for every field type.
updateRenderOnChange	When true, the onRender javascript function is triggered each time the user changes the value of this field. Default is false.
value	The value of the parameter. Can be considered default value. Can be an array for multi-value fields. For number-type values the exponent needs to be between -300 and +300 and max precision is 15. For integer-type values the value needs to between -100000000000000000 and 100000000000000000"

## Examples ### disclosureSection vs featureSection **Disclosure** **sections** **always** have their fields **validated** while **feature sections** only have their fields **validated when the checkbox is checked** and thus their contents are expanded. Use disclosure sections to hide complexity, but still take the values of that section into account. Use feature sections to enable or disable parts of your pipeline. The following code is an example `inputForm.json` with both collapsible section types.

{
  "fields": [
        {
        "id":"MyFeatureSection",
        "type": "featureSection",
        "label": "My featureSection Settings",
        "tooltipText":"My tooltip text",
        "fields": [
            {
            "id": "email_feature",
            "type": "textbox",
            "label": "email",
            "helpText": "This is where you enter the destination email adress",
            "value": ""
             },
            {
            "id": "plaintext_email_feature",
            "type": "checkbox",
            "label": "plaintext_email",
            "helpText": "Send plain-text email instead of HTML.",
            "value": false
            }
            ]
        },
        {
        "id":"disclosure",
        "type": "disclosureSection",
        "label": "My DisclosureSection",
        "fields": [
            {
            "id": "email_disclosure",
            "type": "textbox",
            "label": "email",
            "helpText": "This is where you enter the originating email adress",
            "value": ""
            },
            {
            "id": "plaintext_email_disclosure",
            "type": "checkbox",
            "label": "plaintext_email",
            "helpText": "Send plain-text email instead of HTML.",
            "value": false
            }
            ]
        }
    ]
}

### Tooltip vs Placeholder example The tooltip text is only displayed when you hover over the (i) symbol next to the field and can be used for extensive explanations with formatting. The placeholder text is limited in size and only shown when no value has been entered in the field. {% code overflow="wrap" expandable="true" %} ```json { "id":"markup", "type":"textbox", "label":"markup field", "tooltipText":"Formatted
text", "placeHolderText":"Enter the information for this field" } ``` {% endcode %}

Tree structure example
"choices" can be used for a single list or for a tree-structured list. See below for an example for how to set up a tree structure. ```json { "fields": [ { "id": "myTreeList", "type": "select", "label": "Selection Tree Example", "choices": [ { "text": "trunk", "value": "treetrunk" }, { "text": "branch", "value": "treebranch", "parent":"treetrunk" }, { "text": "leaf", "value": "treeleaf", "parent":"treebranch" }, { "text": "bird", "value": "happybird", "parent":"treebranch" }, { "text": "cat", "value": "cat", "parent": "treetrunk", "disabled": true } ], "minValues": 1, "maxValues": 3, "helpText": "This is a tree example" } ] } ```
## Experimental Features
Feature
Streamable inputs Adding "streamable":true to an input field of type "data" makes it a streamable input.
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://help.bioinsight.illumina.com/connected-analytics/project-web-ui/p-flow/pipelines-new-view/json-based-input-forms/inputform-json.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.