Schema to define form structure for simple import on Algho Buider

The form can be created by inserting the link of form definition on the Algho Builder

{
  "formName": "Zendesk apertura ticket",
  "lang": "it",
  "submitUrl" : "http://www.mysite.com/ws/submit.php",
  "autoSubmit" : true,
  "globalAutoSubmit": false,
  "formType" : "STANDARD",
  "isSensitive" : false,
    "command": null,
    "payload": null,
  "fieldList": [
    {
      "name": "Email",
      "type": "EmailFieldType",
      "questionText": "Email",
      "required": true,
      "maxValuesToSelect": 1,
      "admissibleValues": [],
      "wsAdmissibleValuesList": null,
      "wsValidation": "http://213.183.150.216:51980/solyda/validate_agent_name",
      "hiddenAdmissibleValues": false,
      "externalWSfield": "email"
    },
    {
      "name": "Product",
      "type": "TextFieldType",
      "questionText": "Per quale prodotto?",
      "required": true,
      "maxValuesToSelect": 1,
      "wsAdmissibleValuesList": "http://www.mysite.com/ws/values.php",
      "wsValidation": null,
      "hiddenAdmissibleValues": false,
      "externalWSfield": "product"
    },
    {
      "name": "Title",
      "type": "TextFieldType",
      "questionText": "Inserisci il titolo del ticket",
      "required": true,
      "maxValuesToSelect": 1,
      "admissibleValues": [],
      "wsAdmissibleValuesList": null,
      "wsValidation": null,
      "hiddenAdmissibleValues": false,
      "externalWSfield": "title"
    },
    {
      "name": "Description",
      "type": "TextFieldType",
      "questionText": "Descrivi il ticket",
      "required": true,
      "maxValuesToSelect": 1,
      "admissibleValues": [],
      "wsAdmissibleValuesList": null,
      "wsValidation": null,
      "hiddenAdmissibleValues": false,
      "externalWSfield": "description"
    },
    {
      "name": "Priority",
      "type": "TextFieldType",
      "questionText": "Che priorità vuoi impostare al ticket?",
      "required": true,
      "maxValuesToSelect": 1,
      "admissibleValues": [
        {
          "name": "Bassa"
        },
        {
          "name": "Media"
        },
        {
          "name": "Alta"
        }
      ],
      "wsAdmissibleValuesList": null,
      "wsValidation": null,
      "hiddenAdmissibleValues": false,
      "externalWSfield": "priority"
    }
  ]
}

Form scheme

Key	Description
`formName`	Form name
`lang`	Language code (see table)
`submitUrl`	Url to submit (Optional)
`autoSubmit`	Boolean: auto fill field value
`globalAutoSubmit`	Boolean: auto fill field value with same name in conversation context (Optional)
`formType`	Form type "STANDARD"
`isSensitive`	Boolean: contain sensitive data
`command`	Command action (see table)
`payload`	json string for browser automation. (Optional) See Selenium Ide plugin tools.html
`fieldList`	Array of form fields (see scheme)

Field scheme

Key	Description
`name`	Field name
`type`	Field type defined in Algho builder (see table)
`questionText`	Question text
`required`	Boolean
`maxValuesToSelect`	Max number of values to select
`admissibleValues`	Array of admissible values (optional)
`wsAdmissibleValuesList`	Web service url to retrieve admissible values (optional)
`wsValidation`	Web service url to validate admissible values (optional)
`hiddenAdmissibleValues`	Hide admissible values to client
`externalWSfield`	External Id of field for reference (optional)

FieldType

FieldType can have the following values:

Key	Description
`EmailFieldType`	is an email address
`TextFieldType`	is a plain text
`NumFieldType`	is a number
`DateFieldType`	is a date (yyyy:MM:dd) or a date is extracted from text
`TelFieldType`	is a phone number
`LocationFieldType`	is an address
`HourFieldType`	represents an hour (HH:mm)
`UrlFieldType`	is an URL
`CFFieldType`	represent a tax code
`FullNameFieldType`	is a name and surname or a name and surname are extracted from text
`BirthDateFieldType`	it's a date (yyyy:MM:dd) before today
`NameFieldType`	is a name or a name is extracted from text
`SurnameFieldType`	is a surname or a surname is extracted from text
`FileFieldType`	is an URI referred to a file
`VatFieldType`	it's a VAT number
`HourRangeFieldType`	is a range in the form of HH:mm - HH:mm
`DateRangeFieldType`	is a range in the form of yyyy:MM:dd - yyyy:MM:dd
`DayFieldType`	is a day (Monday, Tuesday, ...), depends on form language
`DayRangeFieldType`	is a range of days (e.g. Monday - Friday)

Language codes

Code	Description
`it`	Italian
`en`	English
`es`	Español
`pt`	Português
`fr`	Français
`de`	Deutsch
`ro`	Românesc
`zh`	中文 (Chinese)

Command codes

Code	Description
`REQUEST_OPERATOR`	Request operator on live chat