Properties

Properties for Input control

Properties

Name	Description	Default	Mandatory
type	Control implementation	N/A
id	Unique ID within the flow	N/A
config.required	Must have a value when leaving the step. true/false	false
config.readonly	Open to edit by enduser. true/false	false
config.type	Type of input value. Valid JSON types are: string, number, integer, boolean.	string
schema.format	Validation of input data. Valid checks: strict, email, phone, postal. See below for more info.	N/A

Example 1

This is an example from a create step where values ​​are to be added. Mail and mobile have checks for correct syntax.

{
    "id": "sn",
    "type": "Input",
    "ui": {
        "ui:size": {
            "md": 6
        }
    },
    "schema": {
        "format": "strict"
    },
    "config": {
        "type": "string",
        "required": true
    }
},
{
    "id": "mail",
    "type": "Input",
    "ui": {
        "ui:size": {
            "md": 6
        }
    },
    "schema": {
        "format": "email"
    },
    "config": {
        "type": "string",
        "required": true
    }
},
{
    "id": "mobile",
    "type": "Input",
    "ui": {
        "ui:size": {
            "md": 6
        }
    },
    "schema": {
        "format": "phone"
    },
    "config": {
        "type": "string"
    }
}

Example 2

This is an example from a create step where values ​​are to be added from a session. In this scenario a user has logged in using Swedish BankID.

{
    "id": "givenName",
    "type": "Input",
    "ui": {
        "ui:size": {
            "md": 6
        }
    },
    "data": "{{{session.givenName}}}",
    "config": {
        "readonly": true
    }
}

Example 3

This is an example from a step where values ​​are to be added from a previous step or from a pipe in a previous step.

{
    "id": "<enter_unique_id_for_this_control>",
    "type": "Input",
    "data": "{{{flow.givenName}}}",
    "config": {
        "type": "string",
        "required": true
    }
}

Special notes for config.type and schema.format properties

The 'config.type' determines how the control is displayed in the view.

For the type 'string' the field can be validated before it is sent to the pipe or next step. The 'strict' validation is recommended as it blocks several common special characters not suitable for Pipe/Valve data handling. Postal is post address.