Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Description

Notes

Localizable

Name

Name used to identify the field

Label

Label to be rendered in the UI

Can be localized.

Accepts a string representing the label to be displayed or an object whose key is the country code and whose value is the relative label to be displayed.
Example:
{
"it-it" : "Messaggio italiano",
"en-gb" : "English message"
}

X

isMandatory

If true the field is required

A * is added in the UI

isVisibleCustomer

If false the filed is hidden

Mainly use for mode auto to fetch info using JS evaluation

isVisibleAgent

False if the content is not intended to be shown to agent for privacy reason

isEditable

False if user is not allowed to change default value

custom_regexp

Regular expression for validating input

If input is not validated, an error message is shown when submitting the form. Not used for textarea

customMandatoryErrorMessage

Error shown when a mandatory field is not filled

X

customValidationErrorMessage

Error shown when input is not valid

X

dc_type

Type of field

Supported values are:

  • text (can be generic or specialized)

    • nickname

    • email

    • name

    • surname

    • phone

  • date

  • textarea

  • checkbox

  • radio

  • select

options

Object whose properties are used as possible values

Used only for radio, select and checkboxCan be localized.

Accepts a string representing the label to be displayed or an object whose key is the country code and whose value is the relative label to be displayed.
Example:
{
"it-it" : "Messaggio italiano",
"en-gb" : "English message"
}

X

customValidationErrorMessage

Error shown when input is not valid

Can be localized.

Accepts a string representing the label to be displayed or an object whose key is the country code and whose value is the relative label to be displayed.
Example:
{
"it-it" : "Messaggio italiano",
"en-gb" : "English message"
}

X

dc_type

Type of field

Supported values are:

  • text (can be generic or specialized)

    • nickname

    • email

    • name

    • surname

    • phone

  • date

  • textarea

  • checkbox

  • radio

  • select

options

Object whose properties are used as possible values

Used only for radio, select and checkbox.

Example:

{
"bike" : {
"it-it" : "bicicletta",
"en-gb" : "bicycle"
},
"motorbike" : {
"it-it" : "moto",
"en-gb" : "motorcycle"
},
"car" : {
"it-it" : "auto",
"en-gb" : "car"
}
}

X

value

field value

if mode is manual then it's considered as pre-filled value, if auto it's evaluted as a JS function returning a value

name

field name

Not visible in UI

mode

field mode

it describes how to use the value field. manual the value is used as default value, auto it's evaluated as a JS function

...