Name | Type | Description |
|---|
_id
| Status | ||
|---|---|---|
|
Internal object identifier
id |
| Data collection unique identifier | ||||||||
title |
| Data collection title | ||||||||
dc_mode |
| Identifies the mode of use. Can assume one of the following values: “chat” “cbn” “cbl” “call” “survey_chat” “survey_call” | ||||||||
next |
| Id of the next data collection to be displayed |
(not used at the moment) | ||||
datacollection |
|
Identifies the data type of the data collection field.
Possibles values are:
| Array of datacollection object. See the table below for a complete list of the properties. |
datacollection Object
Name | Type | description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
dc_type |
| Identifies the data type of the data collection field. Possibles values are: “nickname” “name” “surname” “email” “phone” “date” “textarea” “checkbox” “radio” “select” “info” “time_slot_cbl” “cb_first_slot” “rating_star” “rating_smile” “rating_score” | ||||||||
label |
| Field name to be displayed | ||||||||
isMandatory |
| Specifies if the data collection field must be filled or not | ||||||||
isVisibleAgent |
| Specifies if the data collection field will be visible by the agent | ||||||||
isVisibleCustomer |
| Specifies if the data collection field will be visible by the customer | ||||||||
isEditable |
| Specifies if the data collection field will be editable by the customer | ||||||||
custom_regexp |
| Specifies a regular expression that will be used to validate the customer input | ||||||||
value |
| Value entered by the customer or JS expression to get the data on auto mode. | ||||||||
name |
| Data collection field identifier | ||||||||
mode |
| Field compilation method. Can be set to: “manual” “auto” | ||||||||
options |
| options of the checkbox / radio / select |
...
customMandatoryErrorMessage |
...
|
...
| language | json |
|---|
...
| Message to be displayed in case the required field is not filled in when tryng to go to next step | |||||||||
customValidationErrorMessage |
| Message to be displayed in case the field value not match the custom_regexp when tryng to go to next step | ||||||||
min |
| In case the value of dc_type is “rating_star” or “rating_score”, indicates the minimum value | ||||||||
max |
| In case the value of dc_type is “rating_star” or “rating_score”, indicates the maximum value | ||||||||
step |
| In case the value of dc_type is “rating_star” or “rating_score”, indicates the step from the minimum to the maximum value |
Examples
| Code Block | ||
|---|---|---|
| ||
{
"_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" : [
{
"dc_typeid" : ObjectId("textarea5c6e700404445e26d8dbeee4"),
"labeldc_type" : {
"nickname",
"it-itlabel" : "Suggerimenti",{
"enit-gbit" : "Tips"
},
"isMandatory" : true,Soprannome",
"isVisibleAgenten-gb" : true,"Nickname"
"isVisibleCustomer" : true},
"isEditableisMandatory" : true,
"custom_regexpisVisibleAgent" : ""true,
"customValidationErrorMessageisVisibleCustomer" : ""true,
"customMandatoryErrorMessageisEditable" : {
true,
"it-itcustom_regexp" : ""Per,
favore, scrivi qualcosa", "customMandatoryErrorMessage" : {
"en-gb" : "Please, write something" "it-it" : "Nickname obbligatorio",
}, "valueen-gb" : "",Nickname is mandatory"
"name" : "customer_tips"},
"modecustomValidationErrorMessage" : "manual",
}, {"value" : "",
"dc_typename" : "checkboxnickname",
"labelmode" : {"manual"
},
"it-it" : "Che veicolo possiedi?",
{
"en-gb_id" : "What vehicle you own?"ObjectId("5c6e700404445e26d8dbeee3"),
"dc_type" }: "name",
"optionslabel" : {
"bikeit-it" : {
"Nome",
"iten-itgb" : "bicicletta",Name"
},
"en-gbisMandatory" : false,
"bicycle" "isVisibleAgent" : false,
}, "isVisibleCustomer" : false,
"motorbike" : { "isEditable" : false,
"it-itcustom_regexp" : "moto",
"en-gb"customMandatoryErrorMessage" : "motorcycle",
"customValidationErrorMessage" : "",
}, "value" : "",
"car" : { "name" : "name",
"it-itmode" : "automanual",
},
{
"en-gb" : "car" "dc_type" : "info",
} "label" : {
}, "isMandatoryit-it" : false"",
"isVisibleAgenten-gb" : true,
""
"isVisibleCustomer" : true},
"isEditableisMandatory" : truefalse,
"custom_regexpisVisibleAgent" : ""true,
"customValidationErrorMessageisVisibleCustomer" : ""true,
"customMandatoryErrorMessageisEditable" : ""false,
"valuecustom_regexp" : "",
"namecustomMandatoryErrorMessage" : "veichle",
"modecustomValidationErrorMessage" : "manual",
}, "value" : "<strong style=\"border: 1px {
"dc_type" : "radiosolid; border-radius: 4px; background-color: #99ccf0; color: #f7ecdc; font-style: italic;\">Testo di prova</strong>",
"labelname" : {
"text_info",
"it-itmode" : "Frutto preferito?manual",
},
"en-gb" : "What's your favourite fruit?"{
}"_id" : ObjectId("5c6e700404445e26d8dbeee2"),
"optionsdc_type" : {
"surname",
"blabel" : {
"it-it" : "bananaCognome",
"en-gb" : "banana" "Surname"
},
}, "isMandatory" : false,
"aisVisibleAgent" : {true,
"isVisibleCustomer" : true,
"it-it" : "mela", "isEditable" : true,
"en-gbcustom_regexp" : "apple",
"customMandatoryErrorMessage" : },
"",
"wcustomValidationErrorMessage" : {
"",
"it-itvalue" : "anguria",
"en-gb"name" : "watermelonsurname",
"mode" : "manual"
} }
}],
"__v" : 0
} |
| Code Block | ||
|---|---|---|
| ||
{ "isMandatory_id" : falseObjectId("5cb4969440bbeaf04ae86d6c"), "id" : "fc0450c8-4b2c-42b3-b8c9-04b672ca4a92", "isVisibleAgenttitle" : true, { "isVisibleCustomerit-it" : "Anagrafica trueTest", "isEditable"en-gb" : true, "Registry Test" }, "customdc_regexpmode" : "chat", "next" : "", "customValidationErrorMessagedatacollection" : "", [ { "customMandatoryErrorMessage" : { "dc_type" : "email", "it-itlabel" : "Per favore, scegli un frutto", Email", "isMandatory" : true, "en-gbisVisibleAgent" : "Pleasefalse, choose a fruit" "isVisibleCustomer" : }false, "valueisEditable" : ""false, "namecustom_regexp" : "fruit", "modecustomMandatoryErrorMessage" : "manual" { }, "it-it" : "Email obbligatoria", { "dc_typeen-gb" : "select",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-gb"customMandatoryErrorMessage" : ""Please, choose a color" "customValidationErrorMessage" : }"", "value" : "return $('#myCode').text()", "name" : "colorcustom_code", "mode" : "manualauto" } ], "__v" : 0 } |