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.always_include	Should data be sent to pipe regardless if it is changed or not	false
config.format	Frontend format validation. See more below	N/A
config.pattern	Custom format pattern. Use for custom pattern. Otherwise leave.	N/A

Example

{
    "id": "fullName",
    "type": "Input",
    "data": "${flow.givenName} ${flow.sn}",
    "config": {
        "required": true,
        "readonly": false,
        "always_include": true,
        "pattern": "^[A-Za-z ]{2,50}$"
    }
}

Frontend format validation.

By setting config.format, it guides the user entering value following a defined ruleset. A predefined set is available:

• date: full-date according to RFC3339.

• time: time (time-zone is mandatory).

• date-time: date-time (time-zone is mandatory).

• iso-time: time with optional time-zone.

• iso-date-time: date-time with optional time-zone.

• duration: duration from RFC3339

• uri: full URI.

• uri-reference: URI reference, including full and relative URIs.

• uri-template: URI template according to RFC6570

• email: email address.

• hostname: host name according to RFC1034.

• ipv4: IP address v4.

• ipv6: IP address v6.

• uuid: Universally Unique IDentifier according to RFC4122.

• float: float according to the openApi 3.0.0 specification

• double: double according to the openApi 3.0.0 specification

• password: password string according to the openApi 3.0.0 specification

• postal: /^[A-Za-z0-9 -]{3,10}$/,

• phone: /^[+]?[(]?[0-9]{1,4}[)]?([-s./0-9])$/,

• strict: /^[^";`<>\()[]{}%|!^]+$/u,

Setting a custom regex is done using config.pattern to regex

Example:

"pattern":"^[A-Za-z -]{3,30}$"

• Start (^) and end ($) exactly with

• Only contain uppercase letters (A–Z), lowercase letters (a–z), spaces, or hyphens (-)

• Have a length between 3 and 30 characters

Once set, custom error message needs to be put in for displaing a functional error message:

In this case "phone.error.format".