Versions Compared

Key

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

Name

Type

Description

_id

Status
titlestring

Internal object identifier

id

Status
titlestring

Data collection unique identifier

title

Status
titlestring
/
Status
titleobject

Data collection title

dc_mode

Status
titlesting

Identifies the mode of use. Can assume one of the following values:

“chat”

“cbn”

“cbl”

next

Status
titlestring

Id of the next data collection to be displayed

dc_type

Status
titlestring

Identifies the data type of the data collection field.

Possibles values are:

“nickname”

“name”

“surname”

“email”

“phone”

“date”

“textarea”

“checkbox”

“radio”

“select”

“info”

label

Status
titlestring
/
Status
titleobject

Field name to be displayed

isMandatory

Status
titleboolean

Specifies if the data collection field must be filled or not

isVisibleAgent

Status
titleboolean

Specifies if the data collection field will be visible by the agent

isVisibleCustomer

Status
titleboolean

Specifies if the data collection field will be visible by the customer

isEditable

Status
titleboolean

Specifies if the data collection field will be editable by the customer

custom_regexp

Status
titlestring

Specifies a regular expression that will be used to validate the customer input

value

Status
titlestring

Value entered by the customer or JS expression to get the data on auto mode.

name

Status
titlestring

Data collection field identifier

mode

Status
titlestring

Field compilation method. Can be set to:

“manual”

“auto”

options

Status
titlestring
/
Status
titleobject

options of the checkbox / radio / select

Examples

...

languagejson

...

customMandatoryErrorMessage

Status
titlestring
/
Status
titleobject

Message to be displayed in case the required field is not filled in when tryng to go to next step

customValidationErrorMessage

Status
titlestring
/
Status
titleobject

Message to be displayed in case the field value not match the custom_regexp when tryng to go to next step

Examples

Code Block
languagejson
{
    "_id" : ObjectId("5e81aef78df3ba62c6480e6d5c6e700404445e26d8dbeee1"),
    "id" : "f14cb97467990d2d-eeb05d35-47e84d7d-bd5193ac-c3e32adb6a40df3d9edb636d",
    "title" : {
        "it-it" : "Anagrafica #3#1",
        "en-gb" : "Registry #3#1"
    },
    "dc_mode" : "chat",
    "next" : "",
    "datacollection" : [ 
        {
            "_id" : ObjectId("5c6e700404445e26d8dbeee4"),
            "dc_type" : "textareanickname",
            "label" : {
                "it-it" : "SuggerimentiSoprannome",
                "en-gb" : "TipsNickname"
            },
            "isMandatory" : true,
            "isVisibleAgent" : true,
            "isVisibleCustomer" : true,
            "isEditable" : true,
            "custom_regexp" : "",
 
          "customValidationErrorMessage" : "",
            "customMandatoryErrorMessage" : {
                "it-it" : "Per favore, scrivi qualcosaNickname obbligatorio",
                "en-gb" : "Please,Nickname writeis something"
            },mandatory"
             "value" : "" },
            "namecustomValidationErrorMessage" : "customer_tips",
            "modevalue" : "manual",
        },    "name" :  "nickname",
  {             "dc_type"mode" : "checkboxmanual",
        }, 
  "label" : {    {
            "it-it_id" : "Che veicolo possiedi?",
   ObjectId("5c6e700404445e26d8dbeee3"),
            "en-gbdc_type" : "What vehicle you own?""name",
            "label" : {
   },             "optionsit-it" : {"Nome",
                "bikeen-gb" : {"Name"
            },
       "it-it" : "bicicletta",     "isMandatory" :  false,
            "en-gbisVisibleAgent" : "bicycle"false,
            "isVisibleCustomer" : false,
 },           "isEditable" : false,
    "motorbike" : {      "custom_regexp" : "",
            "it-itcustomMandatoryErrorMessage" : "moto",
            "customValidationErrorMessage" : "",
            "en-gbvalue" : "motorcycle",
            "name"    }: "name",
                "carmode" : {"manual"
        }, 
        {
 "it-it" : "auto",         "dc_type"            "en-gb" : "car": "info",
            "label" : {
     }           "it-it" : }"",
                "isMandatoryen-gb" : false,""
            "isVisibleAgent" : true},
            "isVisibleCustomerisMandatory" : truefalse,
            "isEditableisVisibleAgent" : true,
            "custom_regexpisVisibleCustomer" : ""true,
            "customValidationErrorMessageisEditable" : ""false,
            "customMandatoryErrorMessage"custom_regexp" : "",
            "valuecustomMandatoryErrorMessage" : "",
            "namecustomValidationErrorMessage" : "veichle",
            "modevalue" : "manual"
        }, 
        {<strong style=\"border: 1px solid; border-radius: 4px; background-color: #99ccf0; color: #f7ecdc; font-style: italic;\">Testo di prova</strong>",
            "dc_typename" : "radiotext_info",
            "labelmode" : {"manual"
        }, 
      "it-it" : "Frutto preferito?",{
                 "en-gb"_id" : "What's your favourite fruit?"ObjectId("5c6e700404445e26d8dbeee2"),
            "dc_type"  : }"surname",
            "optionslabel" : {
                "bit-it" : {"Cognome",
                    "iten-itgb" : "bananaSurname",
            },
            "en-gbisMandatory" : "banana"false,
            "isVisibleAgent" : true,
  },          "isVisibleCustomer" : true,
    "a" : {      "isEditable" : true,
            "it-itcustom_regexp" : "mela",

                   "en-gb"customMandatoryErrorMessage" : "apple",
            "customValidationErrorMessage" : "",
 },           "value" : "",
   "w" : {       "name" : "surname",
           "it-it "mode" : "anguriamanual",
        }
      ],
    "en-gb__v" : "watermelon"
0
}
Code Block
languagejson
{
    "_id" : ObjectId("5cb4969440bbeaf04ae86d6c"),
    "id"    }
    : "fc0450c8-4b2c-42b3-b8c9-04b672ca4a92",
    "title" :  },
 {
          "isMandatoryit-it" : "Anagrafica falseTest",
            "isVisibleAgent"en-gb" : true,"Registry Test"
    },
      "isVisibleCustomerdc_mode" : true,
       "chat",
    "isEditablenext" : true"",
    "datacollection" : [ 
      "custom_regexp" : "",{
            "customValidationErrorMessagedc_type" : "email",
            "customMandatoryErrorMessagelabel" : {
           "Email",
    "it-it" : "Per favore, scegli un frutto",  "isMandatory" : true,
            "en-gbisVisibleAgent" : "Pleasefalse,
choose a fruit"          "isVisibleCustomer" :  }false,
            "valueisEditable" : ""false,
            "namecustom_regexp" : "fruit",
            "modecustomMandatoryErrorMessage" : "manual" {
           },     "it-it" : "Email obbligatoria",
 {             "dc_type" : "selecten-gb", : "Email is mandatory"
        "label" : {    },
            "it-itcustomValidationErrorMessage" : "Scegli un colore:",
            "value" : "return  "en-gb" : "Choose a color:"$('#myName').text() + '@enghouse.com'",
            "name" : }"email",
            "optionsmode" : {"auto"
        }, 
      "r" : "red",{
                "g"_id" : ObjectId("green5c6e700404445e26d8dbeee9"),
            "dc_type" : "text",
   "b" : "blue"       "label" : {
   },             "isMandatoryit-it" : "Codice true,cliente",
                "isVisibleAgenten-gb" : true,
 "Customer code"
          "isVisibleCustomer" : true},
            "isEditableisMandatory" : true,
            "custom_regexpisVisibleAgent" : ""false,
            "customValidationErrorMessageisVisibleCustomer" : ""false,
            "customMandatoryErrorMessage" : {
   isEditable" : false,
            "it-itcustom_regexp" : "Per favore, scegli una macchina",
 
              "en-gbcustomMandatoryErrorMessage" : "Please",
choose a color"          "customValidationErrorMessage" :  }"",
            "value" : "return $('#myCode').text()",
            "name" : "colorcustom_code",
            "mode" : "manualauto"
        }
    ],
    "__v" : 0
}