Document Title: Orbita Chatbot V3 Solution
Creation date:
Author: ORBITA
The Chatbot V3 is an extension of the existing chatbot where you can have multiple advantages such as never-ending sessions, multiple bots without the need to change the endpoint, the ability for the admin to take charge of any conversation, the ability for the admin to customize the chatbot UI, and so on.
Features
Real-time Communication - Messages can be pushed from the server to any and all connected clients, allowing requests and responses to be handled asynchronously.
Customize the Chatbot UI - Use or tweak Orbita’s out-of-the-box UI, or completely customize the chatbot to represent unique branding and layout.
Targeted Messaging - Push communication to singular users or multiple personas with the ability to target message pushes to connected clients.
How do you use it?
To use the Chatbot V3’s capabilities with your existing chatbot.
Login to Experience Manager and Select your project.
Open Experience Designer.
Import the below flow to any Experience Designer tab. Refer How do I export and import flows in Experience Designer
[ { "id": "e14ca34d.06aff", "type": "tab", "label": "Flow 3", "disabled": false, "info": "" }, { "id": "fc515ee4.5a52e", "type": "alexa-flow-config reff", "z": "e14ca34d.06aff", "skillConfig": "496cb5db.ebb6fc", "x": 100, "y": 50, "wires": [] }, { "id": "61b0f7e6.4c5f48", "type": "orbita-bot-provider-v2", "z": "e14ca34d.06aff", "name": "", "botInParser": "var _ = global.get('lodash');\n// msg.payload.originalRequest.data = {\n// \"surveyID\":\"10000\"\n// }\nif(msg && msg.req && msg.req.query) {\n \n msg.payload.originalRequest.data.surveyID=msg.req.query.surveyId;\n}\n\nvar socketIOId = _.get(msg, 'req.socketIOId', null);\n\nif (socketIOId) {\n _.set(msg, 'payload.originalRequest.data.socketIOId', socketIOId);\n}\n", "botOutParser": "msg.payload.micInput=true;\nmsg.payload.startAlignmentTop = true;\nmsg.enableArrayResponse = true\n", "transcriptEnabled": false, "ttsconfig": "{\n \"languageCode\": \"en-US\",\n \"ssmlGender\": \"MALE\",\n \"audioEncoding\": \"MP3\"\n}", "providerType": "Google", "skillConfig": "496cb5db.ebb6fc", "token": "", "noerr": 0, "nlpData": false, "x": 280, "y": 200, "wires": [ [ "b5af9a23.f7e658" ] ] }, { "id": "3a53d950.2a2966", "type": "bot-in", "z": "e14ca34d.06aff", "skillConfig": "496cb5db.ebb6fc", "name": "", "rules": [], "x": 90, "y": 200, "wires": [ [ "61b0f7e6.4c5f48" ] ] }, { "id": "9e2adb8b.f586d8", "type": "bot-out", "z": "e14ca34d.06aff", "skillConfig": "496cb5db.ebb6fc", "name": "", "x": 640, "y": 200, "wires": [] }, { "id": "b5af9a23.f7e658", "type": "function", "z": "e14ca34d.06aff", "name": "", "func": "msg.payload.directive = {\n \"type\": \"mainmenu\",\n \"title\":\"Menu options\",\n \"buttons\": []\n }\nreturn msg;", "outputs": 1, "noerr": 0, "x": 450, "y": 200, "wires": [ [ "9e2adb8b.f586d8" ] ] }, { "id": "44a664df.01bacc", "type": "template", "z": "e14ca34d.06aff", "name": "", "field": "payload", "fieldType": "msg", "format": "handlebars", "syntax": "mustache", "template": "<!doctype html>\n<html lang=\"en\">\n<head>\n <title>Orbita v3 Bot</title>\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <style>\n body{\n font-family: sans-serif;\n background-color:#fff !important;\n }\n </style>\n</head>\n<body>\n <link rel=\"preload\" href=\"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css\" as=\"style\" onload=\"this.onload=null;this.rel='stylesheet'\">\n <script src=\"/chatbot/v2/adaptive-lib/adaptivecards-templating.min.js\"></script>\n <script src=\"/chatbot/v2/adaptive-lib/adaptivecards.js\"></script>\n <script type=\"text/javascript\" src=\"https://unpkg.com/markdown-it/dist/markdown-it.js\"></script>\n <script src=\"https://cdn.socket.io/3.1.3/socket.io.min.js\" integrity=\"sha384-cPwlPLvBTa3sKAgddT6krw0cJat7egBga3DJepJyrLl4Q9/5WLra3rrnMcyTyOnh\" crossorigin=\"anonymous\"></script>\n <script>window.jQuery || /* reload from own domain here */;</script>\n <script src=\"https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js\" integrity=\"sha512-894YE6QWD5I59HgZOGReFYm4dnWc1Qt5NtvYSaNcOP+u1T9qYdvdihz0PPSiiqn/+/3e7Jo4EaG7TubfWGUrMQ==\" crossorigin=\"anonymous\" referrerpolicy=\"no-referrer\"></script>\n <script src=\"/chatbot/v3/chat-plugins.js\"></script>\n <script src=\"/chatbot/v3/chat.js\"></script>\n <link rel=\"stylesheet\" href=\"/chatbot/v3/style.css\" />\n <link rel=\"stylesheet\" type=\"text/css\" href=\"https://cdn.jsdelivr.net/npm/daterangepicker/daterangepicker.css\" />\n <link href=\"https://cdn.jsdelivr.net/npm/bootstrap@5.0.1/dist/css/bootstrap.min.css\" rel=\"stylesheet\">\n <script>\n var latestResponse = {};\n\n OrbitaBotPlugins.BotPlugin.init({\n botId:'bot-v3',\n width: '300px',\n height: '600px',\n });\n OrbitaChatBotV3.init({\n projectId: \"{{projectId}}\",\n serverUrl: \"{{req.headers.x-forwarded-proto}}\"+\"://\"+\"{{req.headers.host}}\",\n isCustomUi: true,\n botContainerId: 'bot-v3',\n botContentId: 'messages',\n botInputMessageId: 'input',\n botSendButtonId: 'orbita-send',\n botMicId: 'chatMic',\n botSpeakerId: 'un-mute',\n botMenuId: 'menu-icon',\n botIcon: 'chat-icon',\n botClose: 'menu',\n botBannerIcon: 'banner-title',\n launchWord: 'opens',\t\n customData : {\t\n chooseFlow: \"{{req.params.chooseFlow}}\"\t\n }\n });\n function afterResponse(responseData) { \n const myData = {...responseData};\n latestResponse = myData;\n\n if (myData.directive && myData.directive.buttons){\n let buttons = myData.directive.buttons;\n $('.menu-slider ul').empty();\n $.each(buttons, function( key, button ){\n $('.menu-slider ul').append('<li onClick=\"OrbitaChatBotV3.hook(\\'send_message\\',\\''+button.value+'\\');$(\\'.menu-icon\\').trigger(\\'click\\');\">'+button.text+'</li>'); \n });\n }\n }\n OrbitaChatBotV3.registerEvent({eventName: \"afterResponse\", callbackFunction: afterResponse});\n </script>\n</body>\n</html>", "output": "str", "x": 460, "y": 160, "wires": [ [ "ba26ea96.a4b308" ] ] }, { "id": "ba26ea96.a4b308", "type": "http response", "z": "e14ca34d.06aff", "name": "", "statusCode": "", "headers": {}, "x": 630, "y": 160, "wires": [] }, { "id": "2a50f9aa.75c016", "type": "http in", "z": "e14ca34d.06aff", "name": "", "url": "/v3Bot", "method": "get", "upload": false, "swaggerDoc": "", "x": 120, "y": 160, "wires": [ [ "824df9ab.ed4278" ] ] }, { "id": "7daae3dc.3bc6bc", "type": "comment", "z": "e14ca34d.06aff", "name": "v3Bot View", "info": "", "x": 100, "y": 120, "wires": [] }, { "id": "824df9ab.ed4278", "type": "function", "z": "e14ca34d.06aff", "name": "", "func": "const util = global.get('orbitaUtil');\nmsg.projectId = util.getProjectId(node);\nreturn msg;", "outputs": 1, "noerr": 0, "x": 310, "y": 160, "wires": [ [ "44a664df.01bacc" ] ] }, { "id": "496cb5db.ebb6fc", "type": "alexa-skill-config", "skillname": "Documentation Flows", "projectId": "5cf9249637e124a03087780b", "intents": "[]", "skillstate": "", "disableLogging": false }, { "id": "slots", "type": "slots", "z": "", "slots": [] } ]
Following the above steps will create a new flow in the Experience Designer as shown below.
Add cdnjs.cloudflare.com to the whitelist. 3.2.26 Whitelisting
Coming from version 2 of the bot
Bot In Node
The Bot In node listens to any pushes from the connected clients. Technically, receives socket events from the webpage.
Bot Out Node
Emits a message to the specified client connected (SocketID). Technically, sends socket events to the webpage.
Connected Bots
The Connected Bots node will return an array of all connected clients (socket IDs) at the project level.
No iframes
The Chatbot V3 is not dependent on an iframe to integrate the chatbot into a webpage.
Whitelisting
To successfully launch Chatbot V3 from your environment, you have to whitelist the below domains. 3.2.26 Whitelisting
https://cdn.jsdelivr.net
https://cdnjs.cloudflare.com
https://code.jquery.com
https://cdn.jsdelivr.net
https://cdn.socket.io
Monitoring conversations using Chatbot V3
Using Chatbot V3, you can have a Chatbot Admin to monitor the chatbot users' conversations.
Sending messages to all connected clients (all SocketIDs)
As a Chatbot Admin, you can send notifications or messages to all the connected clients.
To send out a custom message;
Import the below code.
[ { "id": "cbd070ff.8e9ba", "type": "function", "z": "e14ca34d.06aff", "name": "Send Message to All", "func": "msg.payload = {\n \"text\" : \"Hello you are recieving a push message from server!\"\n}\nmsg.socketIOEmit = \"emit\";\nreturn msg;", "outputs": 1, "noerr": 0, "x": 320, "y": 340, "wires": [ [ "4a5617b7.34e358" ] ] }, { "id": "1b78332e.89e5ed", "type": "inject", "z": "e14ca34d.06aff", "name": "", "topic": "", "payload": "{}", "payloadType": "json", "repeat": "", "crontab": "", "once": false, "onceDelay": 0.1, "x": 110, "y": 340, "wires": [ [ "cbd070ff.8e9ba" ] ] }, { "id": "4a5617b7.34e358", "type": "bot-out", "z": "e14ca34d.06aff", "skillConfig": "496cb5db.ebb6fc", "name": "", "x": 620, "y": 340, "wires": [] }, { "id": "496cb5db.ebb6fc", "type": "alexa-skill-config", "skillname": "Documentation Flows", "projectId": "5cf9249637e124a03087780b", "intents": "[]", "skillstate": "", "disableLogging": false }, { "id": "slots", "type": "slots", "z": "", "slots": [] } ]
Change the content within the
text
property in the function node.Trigger the Inject node to send your custom message to all the connected SocketIDs.
Sending messages to one connected client (one SocketID)
As a Chatbot Admin, you can send notifications or messages to all the connected clients.
To send out a custom message to a particular user;
Import the below code.
[ { "id": "db801cd4.83c7c", "type": "function", "z": "e14ca34d.06aff", "name": "Send Message to specific socket id", "func": "msg.payload = {\n \"text\":\"Hello you are lucky today!\"\n}\nmsg.socketIOId = \"KGJsMLK_PwM55QfYAAC_\";\nreturn msg;", "outputs": 1, "noerr": 0, "x": 360, "y": 400, "wires": [ [ "949a42a7.df33" ] ] }, { "id": "949a42a7.df33", "type": "bot-out", "z": "e14ca34d.06aff", "skillConfig": "496cb5db.ebb6fc", "name": "", "x": 620, "y": 400, "wires": [] }, { "id": "8b452e8e.ff63f", "type": "inject", "z": "e14ca34d.06aff", "name": "", "topic": "", "payload": "{}", "payloadType": "json", "repeat": "", "crontab": "", "once": false, "onceDelay": 0.1, "x": 110, "y": 400, "wires": [ [ "db801cd4.83c7c" ] ] }, { "id": "496cb5db.ebb6fc", "type": "alexa-skill-config", "skillname": "Documentation Flows", "projectId": "5cf9249637e124a03087780b", "intents": "[]", "skillstate": "", "disableLogging": false }, { "id": "slots", "type": "slots", "z": "", "slots": [] } ]
Change the socketID and the message property in the function node.
Trigger the Inject node to send your custom message to that specific SocketIDs.
You can display these custom messages either on the chatbot or as a notification pop up.
Customizations
You can customize the chatbot using the Project side menu > Develop > Chatbot settings > Custom CSS and Custom JS.
Adding Custom JS
You can inject the JS code via the Custom JS tab as per your use case.
Adding Custom CSS
Embed the Bot in a section
Import the below flow to the Experience designer to have a chatbot in the center of the page.
[ { "id": "b7cf53f8.4464", "type": "template", "z": "cd6c5936.243d78", "name": "", "field": "payload", "fieldType": "msg", "format": "handlebars", "syntax": "mustache", "template": "<!doctype html>\n<html lang=\"en\">\n<head>\n <title>Orbita v3 Demo</title>\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <style>\n body #bot-v3.chat-container{\n display:block;\n }\n #bot-v3,\n #bot-v3 .chatbox{\n position: fixed;\n display:block;\n right: 10px;\n bottom: 50px;\n height: 550px;\n width: 345px;\n border-radius: 10px;\n box-shadow: 5px 5px 15px rgb(119 119 119 / 50%);\n overflow: hidden;\n z-index: 999;\n left: calc(50% - 175px);\n top: 150px;\n }\n #bot-v3 #chatLiveChatTrigger {\n position: absolute;\n right: 20px;\n top: 100px;\n z-index: 999;\n cursor:pointer;\n }\n \n #bot-v3 #waitingAgent {\n clear:both;\n text-align: center;\n }\n .chat-icon{\n display:none !important;\n }\n\n body{\n font-family: sans-serif;\n background-color:#eee !important;\n }\n </style>\n</head>\n<body>\n <link rel=\"preload\" href=\"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css\" as=\"style\" onload=\"this.onload=null;this.rel='stylesheet'\">\n <script src=\"/chatbot/v2/adaptive-lib/adaptivecards-templating.min.js\"></script>\n <script src=\"/chatbot/v2/adaptive-lib/adaptivecards.js\"></script>\n <script type=\"text/javascript\" src=\"https://unpkg.com/markdown-it/dist/markdown-it.js\"></script>\n <script src=\"https://cdn.socket.io/3.1.3/socket.io.min.js\" integrity=\"sha384-cPwlPLvBTa3sKAgddT6krw0cJat7egBga3DJepJyrLl4Q9/5WLra3rrnMcyTyOnh\" crossorigin=\"anonymous\"></script>\n <script src=\"https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js\" integrity=\"sha512-894YE6QWD5I59HgZOGReFYm4dnWc1Qt5NtvYSaNcOP+u1T9qYdvdihz0PPSiiqn/+/3e7Jo4EaG7TubfWGUrMQ==\" crossorigin=\"anonymous\" referrerpolicy=\"no-referrer\"></script>\n <script src=\"/chatbot/v3/chat-plugins.js\"></script>\n <script src=\"/chatbot/v3/chat.js\"></script>\n <link rel=\"stylesheet\" href=\"/chatbot/v3/style.css\" />\n <link rel=\"stylesheet\" type=\"text/css\" href=\"https://cdn.jsdelivr.net/npm/daterangepicker/daterangepicker.css\" />\n <link href=\"https://cdn.jsdelivr.net/npm/bootstrap@5.0.1/dist/css/bootstrap.min.css\" rel=\"stylesheet\">\n <script>\n var clickTag = \"https://www.orbita.ai\";\n var latestResponse = {};\n function adClick(){\n window.open(clickTag, `_blank`);\n }\n OrbitaBotPlugins.BotPlugin.init({\n botId:'bot-v3',\n width: '300px',\n height: '600px',\n });\n OrbitaChatBotV3.init({\n projectId: \" {{projectId}}\",\n serverUrl: \" {{req.headers.x-forwarded-proto}}\"+\"://\"+\" {{req.headers.host}}\",\n isCustomUi: true,\n botContainerId: 'bot-v3',\n botContentId: 'messages',\n botInputMessageId: 'input',\n botSendButtonId: 'orbita-send',\n botMicId: 'chatMic',\n botSpeakerId: 'un-mute',\n botMenuId: 'menu-icon',\n botIcon: 'chat-icon',\n botClose: 'menu',\n botBannerIcon: 'banner-title'\n });\n function afterResponse(responseData) { \n const myData = {...responseData};\n latestResponse = myData;\n\n if (myData.directive && myData.directive.buttons){\n let buttons = myData.directive.buttons;\n $('.menu-slider ul').empty();\n $.each(buttons, function( key, button ){\n $('.menu-slider ul').append('<li onClick=\"OrbitaChatBotV3.hook(\\'send_message\\',\\''+button.value+'\\');$(\\'.menu-icon\\').trigger(\\'click\\');\">'+button.text+'</li>'); \n });\n }\n\n if (myData.session && myData.session.chatMode && myData.session.chatMode !== null){\n $('.chatbox').prepend(`<i id=\"chatLiveChatTrigger\" title=\"End session with agent\" onClick=\"OrbitaChatBotV3.hook('send_message', 'Please end my session');$(this).remove();\" class=\"fas fa-life-ring fa-times-circle lc_enabled\"/>`);\n }\n }\n OrbitaChatBotV3.registerEvent({eventName: \"afterResponse\", callbackFunction: afterResponse});\n \n $('.chat input').on('keypress', function (e) {\n if (e.which == 13) {\n if (latestResponse.session && latestResponse.session.chatMode && latestResponse.session.chatMode !== null){\n $('.chat input, .chat button').css('display', 'block');\n }\n return false;\n }\n });\n\n OrbitaChatBotV3.hook('connect');\n </script>\n</body>\n</html>", "output": "str", "x": 440, "y": 160, "wires": [["ca48379c.d812b8"]] }, { "id": "ca48379c.d812b8", "type": "http response", "z": "cd6c5936.243d78", "name": "", "statusCode": "", "headers": {}, "x": 570, "y": 160, "wires": [] }, { "id": "6d574e22.32d22", "type": "http in", "z": "cd6c5936.243d78", "name": "", "url": "/centerView", "method": "get", "upload": false, "swaggerDoc": "", "x": 140, "y": 160, "wires": [["b186eca9.c0b9e"]] }, { "id": "b186eca9.c0b9e", "type": "function", "z": "cd6c5936.243d78", "name": "", "func": "const util = global.get('orbitaUtil');\nmsg.projectId = util.getProjectId(node);\nreturn msg;", "outputs": 1, "noerr": 0, "x": 310, "y": 160, "wires": [["b7cf53f8.4464"]] }, { "id": "slots", "type": "slots", "z": "", "slots": [] } ]
Supported Directives on Chatbot V3
Flow Studio Control’s Directives | Experience Designer’s Directives |
---|---|
Choose many option | Autocomplete -- client side |
Choose many option with none of the above | Autocomplete -- server side |
Choose one option | Bootstrap carousel |
Yes/No options | Bootstrap carousel with filter options |
Single input control with texbox input type - hidden | Cardlist |
Single input control with texbox input type -- single line | Cardlist with filter options |
Single input control with texbox input type -- multi line | Html5 - Added properties (id, html, element) |
Single input control with input type Date | Adaptive card |
Single input control with input type DateTime | |
Single input control with input type time | |
Single input control with input type email | |
Single input control with input type phone number | |
Rating control |
Hierarchy of settings followed on Chatbot V2 holds good for Chatbot V3:
The Bot provider V2 node (Experience Designer) > Flow studio control directive > Chatbot settings (Project Side navigation menu in Experience Manager).