In Orbita, you can design the survey flow to capture data of a partially completed survey. You can use this data to send a link to the survey taker to complete the partially completed survey from where they left off.
Partial survey flow
This document shows how to configure your survey to capture the data of a partially completed survey.
The following image shows the sample flow. The nodes that are used in this sample flow are explained in the following sections.
Create a dynamic schema
The first step is to create a dynamic schema to store the survey information.
Create a dynamic schema with the fields “Survey ID”, “Session ID”, “Survey Data”, and “Survey Info”. See, create a schema
The following sample schema code saves data of a partial survey.
{
"fields" : [
{
"label" : "Session_ID",
"key" : "sessionid",
"isDefault" : false,
"validation" : [
{
"required" : false
}
],
"options" : [],
"ref" : "",
"fieldType" : "text",
"type" : "String"
},
{
"key" : "surveyid",
"label" : "surveyID",
"isDefault" : false,
"validation" : [
{
"required" : false
}
],
"options" : [],
"ref" : "",
"fieldType" : "text",
"type" : "String"
},
{
"label" : "Survey_Data",
"key" : "surveydata",
"isDefault" : false,
"validation" : [
{
"required": true
}
],
"options" : [],
"ref" : "",
"fieldType" : "json",
"type" : "Object"
},
{
"label" : "Title",
"key" : "title",
"isDefault" : false,
"validation" : [],
"options" : [],
"ref" : "",
"fieldType" : "text",
"type" : "String"
},
{
"label" : "Tags",
"key" : "tags",
"isDefault" : false,
"validation" : [],
"options" : [],
"ref" : "",
"fieldType" : "text",
"type" : "Object"
}
]
}
This schema is used to capture the survey data that the user feeds in. Using this data, the admin user will know if a survey is completed or partially completed.
The admin user then can generate the partial survey URLs and send them to the users for them to continue their surveys.
Get survey ID and session ID
Once a survey is triggered, the Survey ID and the Session ID will be stored in Dynamic Data.
From the project side menu, select Reporting > Data
Select the Partial-Survey Schema from the schema drop-down.
Select the document from the list.
You can see the Survey ID and the Session ID.
Select survey
The function node with the name Select Survey fetches the surveyId and the sessionId from the incoming request and pushes the data to Dynamic Data Manager.
var _ = global.get('lodash');
msg.payload.surveyId = _.get(msg, 'payload.originalDetectIntentRequest.payload.surveyID', '');
var sessionId = _.get(msg, 'payload.originalDetectIntentRequest.payload.sessionId', null)
if (sessionId){
_.set(msg, 'payload.sessionId', sessionId);
}
Dynamic Data Manager (Get)
The Dynamic Data manager fetches the data that matches the surveyId and the sessionId from the database.
Set partial-survey data
This function node constructs the survey info such that the survey starts from where the user left off.
var _ = global.get('lodash');
var surveyContent = _.get(msg, 'data.dynamicData.result.0.surveydata', null);
if (surveyContent && surveyContent.surveyInfo) {
_.set(msg, 'orbita.session.surveyInfo', surveyContent.surveyInfo)
}
return msg;
Save partial-survey data
This function node contains the logic to save the partial survey to Dynamic Data and delete the completed surveys from Dynamic Data.
var _ = global.get('lodash');
var surveyData = {
answers: _.get(msg, 'payload.answers', null),
survey: _.get(msg, 'payload.orbita.survey', null),
surveyInfo: _.get(msg, 'payload.session.attributes.orbitaSession.surveyInfo', null)
}
var surveyid = _.get(msg, 'orbita.session.surveyInfo.surveyId', null);
var partialSurvey = {
surveydata: surveyData,
surveyid: surveyid
}
_.set(msg, 'payload.data', partialSurvey);
//If survey completed, we need to delete the partial survey from dynamic data.
if (_.get(msg, 'payload.orbita.survey.completedSurveyQuestions', null)) {
return [null, msg]
}
return [msg, null];
Bot Provider V2 node
Place the following code in Bot In Parser of Bot Provider V2 node to let the Bot Provider V2 node process the Survey ID and the Session ID given in the URL.
var _ = global.get('lodash');
msg.payload.originalRequest.data.surveyID=msg.req.query.surveyID;
//to support the session ID from query Param
msg.payload.sessionId = msg.req.query.sessionId || msg.payload.sessionId;
var querySessionId = _.get(msg, 'req.query.sessionId', null);
if (querySessionId) {
_.set(msg, 'payload.originalRequest.data.sessionId', querySessionId);
}
