inputForm.json

inputForm.json

The JSON schema allowing you to define the input parameters. See the inputForm.json page for syntax details.

The inputForm.json file has a size limit of 10 MB and a maximum of 200 fields.

Parameter types

Type	Usage
textbox	Corresponds to stringType in xml.
checkbox	A checkbox that supports the option of being required, so can serve as an active consent feature. (corresponds to the booleanType in xml).
radio	A radio button group to select one from a list of choices. The values to choose from must be unique.
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.
number	The value is of Number type in javascript and Double type in java. (corresponds to doubleType in xml).
integer	Corresponds to java Integer.
data	Data such as files.
section	For splitting up fields, to give structure. Rendered as subtitles. No values are to be assigned to these fields.
text	To display informational messages. No values are to be assigned to these fields.
fieldgroup	Can contain parameters or other groups. Allows to 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. Does not support the emptyValuesAllowed attribute.

Parameter Attributes

These attributes can be used to configure all parameter types.

Attribute	Purpose
label	The display label for this parameter. Optional but recommended, id will be used if missing.
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.
maxValues	The maximal amount of values that need to be present. Default when not set is 1.
minMaxValuesMessage	The error message displayed when minValues or maxValues is not adhered to. When not set, a default message is generated.
helpText	A helper text about the parameter. Will be displayed in smaller font with the parameter.
placeHolderText	An optional short hint ( a word or short phrase) to aid the user when the field has no value.
value	The value of the parameter. Can be considered default value.
minLength	Only applied on type="textbox". Value is a positive integer.
maxLength	Only applied on type="textbox". Value is a positive integer.
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.
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.
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 choicetrees. "availableWhen" can be used for conditional presence of the choice based on values of other fields. Parent and value must be unique, you can not use the same value for both.
fields	The list of sub fields for type fieldgroup.
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 ICA 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.
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.
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.
disabled	Shows the parameter but makes editing it impossible. The value can still be altered by onRender.js.
emptyValuesAllowed	When maxValues is 1 or not set and emptyValuesAllowed is true, the values may contain null entries. Default is false.
updateRenderOnChange	When true, the onRender javascript function is triggered each time the user changes the value of this field. Default is false.
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).

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.

{
  "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.