This document shows how to configure and capture the data of a partially completed survey using the flow studio.
Experience Manager
To capture the session details and the flow data, you have to create a dynamic schema.
Dynamic schema
The first step is to create a dynamic schema to store the flow information.
Create a dynamic schema, name it, and include the fields “flowid”, “sessionid”, and “flowdata”. See, How do I create a schema?
The following sample schema is a template that allows you to save data of a partially completed flow studio.
{
"fields": [
{
"type": "String",
"fieldType": "text",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": false
}
],
"isDefault": false,
"label": "Session_ID",
"key": "sessionid"
},
{
"type": "String",
"fieldType": "text",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": false
}
],
"isDefault": false,
"key": "flowid",
"label": "flow_ID"
},
{
"type": "Object",
"fieldType": "json",
"ref": "",
"options": [],
"multiple": false,
"validation": [
{
"required": true
}
],
"isDefault": false,
"label": "flow_Data",
"key": "flowdata"
}
]
}
This schema is used to capture the flow data that the user feeds in. Using this data, the admin user will know if a flow is completed or partially completed.
The admin user then can generate the partial flow URLs and send them to the users for them to continue their flow.
Get survey ID and session ID
Once a survey is triggered, the Survey ID and the Session ID will be stored in Dynamic Data. You access the saved data in the data section of the side menu.
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.
Experience Designer
In the Experience designer, you can design a flow to capture data of a partially completed flow studio. You can use this data to send a link to the chatbot user to complete the partially completed flow studio from where he/she left off.
The following image shows the sample flow. The nodes that are used in this sample flow are explained in the following sections.
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.
Ensure that you select the correct schema.
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);
}
