This document shows how to configure and capture the data of a partially completed questionnaire using the flow studio.
This flow allows you to save a conversation of the user if it is not completed.
You can send him a link with the sessionid and/or flowid to prompt him to complete the partially finished survey.
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 Schemas?
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.
Sample URL (with flowid and sessionid): https://yourdomain.orbita.cloud:8443/oeapi/bot/myfirstchatbot?flowId=5c1190a401bc681000d6698b&sessionId=:5a158f6422d2ab0f0036df81:c6388e6b-c0f7-4b0e-828f-2c665557a4cf
Append ?flowId='####'&sessionId='####' at the end of your chatbot URL to launch the partial 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 flow Schema from the schema drop-down.
Select the document from the list.
You can see the flow_ID and the Session_ID in the document.
Experience Designer
In the Experience designer, you need to design a flow to capture data of a partially completed flow studio. You can use this collected 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.
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 flowID and the sessionID given in the URL.
var _ = global.get('lodash');
msg.payload.originalRequest.data.flowId=msg.req.query.flowId;
//to support the session ID from query Param
if (msg.req.query.sessionId){
msg.payload.sessionId = msg.req.query.sessionId;
}
else {
msg.payload.sessionId = msg.payload.sessionId;
}
var querySessionId = _.get(msg, 'payload.sessionId', null);
if (querySessionId) {
_.set(msg, 'payload.originalRequest.data.sessionId', querySessionId);
}
Function nodes
There are 3 function nodes used in the flow.
Select Flow studio
The function node with the name Select Flow studio fetches the flowId and the sessionId from the incoming request and pushes the data to Dynamic Data Manager.
var _ = global.get('lodash');
if(_.get(msg, 'payload.originalDetectIntentRequest.payload.flowId', undefined)){
msg.payload.flowId = _.get(msg, 'payload.originalDetectIntentRequest.payload.flowId', '');
}
else{
msg.payload.flowId = ''; // Place your flow id here
}
var sessionId = _.get(msg, 'payload.originalDetectIntentRequest.payload.sessionId', null)
if (sessionId){
_.set(msg, 'payload.sessionId', sessionId);
}
return msg;
Set partial Flow studio data
This function node constructs the flow info such that the flow starts from where the user left off.
var _ = global.get('lodash');
var flowContent = _.get(msg, 'data.dynamicData.result.0.flowdata', null);
if (flowContent && flowContent.flowInfo) {
_.set(msg, 'orbita.session.flowInfo', flowContent.flowInfo)
}
return msg;
Save partial Flow studio data
This function node contains the logic to save the partially completed flow data to Dynamic Data and delete the completed flow data from Dynamic Data.
var _ = global.get('lodash');
var flowInfo = msg.payload.session.attributes.orbitaSession.flowInfo;
var partialFlowStudio = {
flowdata: flowInfo,
flowid: flowInfo.flowId,
sessionid: msg.payload.originalDetectIntentRequest.payload.sessionId
}
_.set(msg, 'payload.data', partialFlowStudio);
//If the flow studio flow is completed, we need to delete the partial flow studio data from dynamic data.
if (msg.orbita.session.flowInfo.state == 'DONE') {
return [null, msg]
}
return [msg, null];
Dynamic Data Manager nodes
Dynamic Data Manager (Get)
The Dynamic Data manager fetches the data that matches the flowId and the sessionId from the database.
Ensure that you select the correct schema in the model field of the node.
Dynamic Data Manager (Upsert)
This node will search for the sessionid in the dynamic data;
if sessionid is found, it updates the document with the new data.
if sessionid is not found, it will create a new document with the new data.
Dynamic Data Manager (Delete)
This node will search for the sessionid from the dynamic data and deletes that document.
