Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • On your Flow Studio main page, hover over the new flow conversation you’ve created > Verticle ellipses button > Import/export.

...

    ...

    • Select the Import tab > Copy the template code below and paste it here > Import.

    ...

    Flow Studio Sample Conversation Template Code:

    Code Block
    {
        "flowData": {
            "class": "GraphLinksModel",
            "copiesKey": false,
            "linkFromPortIdProperty": "fromPort",
            "linkToPortIdProperty": "toPort",
            "nodeDataArray": [
                {
                    "key": "857428463371497251",
                    "name": "Start",
                    "description": "",
                    "type": "start",
                    "category": "",
                    "loc": "232.52284749830795 70.10354461669922",
                    "size": "80 80"
                },
                {
                    "key": "402026513763859450",
                    "name": "End",
                    "description": "Thanks for your time.\nThe conversation Endsconversation ends here\n",
                    "type": "end",
                    "category": "",
                    "loc": "232.52284749830795 850.0689865401407",
                    "size": "80 80",
                    "multiScreen": {
                        "description": "",
                        "validation": {
                            "valid": "",
                            "invalid": ""
                        },
                        "voice": {
                            "sayText": "<p>Thanks for your time.<br />\nThe conversation <strong>End<conversation <strong>ends</strong>sstrong> here</p>\n",
                            "rePrompt": ""
                        },
                        "chat": {
                            "chatText": ""
                        },
                        "screen": {
                            "shortTitle": "",
                            "longTitle": "",
                            "body": "",
                            "smallImage": "",
                            "largeImage": ""
                        },
                        "buttons": {
                            "type": "dropdown",
                            "name": "buttons",
                            "choices": []
                        }
                    },
                    "directives": {
                        "micInput": true,
                        "keyboardInput": true,
                        "waitTimeNoAnimation": false,
                        "endSession": false
                    }
                },
                {
                    "key": "742436401836062521",
                    "name": "Say",
                    "description": "Welcome to your first conversation flow using flow studio\n",
                    "type": "message",
                    "category": "",
                    "loc": "232.52284749830793 261.8334813484056",
                    "multiScreen": {
                        "voice": {
                            "sayText": "<p>Welcome to your first conversation flow using flow studio</p>\n"
                        },
                        "chat": {
                            "chatText": ""
                        }
                    }
                },
                {
                    "key": "417833740235547202",
                    "name": "Rating",
                    "description": "Please rate the document you just viewed.\n",
                    "type": "rating",
                    "category": "",
                    "loc": "107.52284749830794 658.3390498084344",
                    "rateValues": [
                        {
                            "value": "1",
                            "text": "",
                            "data": ""
                        },
                        {
                            "value": "2",
                            "text": "",
                            "data": ""
                        },
                        {
                            "value": "3",
                            "text": "",
                            "data": ""
                        }
    ,
                   ],              {
      "multiScreen": {                     "descriptionvalue": "4",
                            "validationtext": {"",
                            "validdata": "",
                        },
       "invalid": ""                 {
       },                     "voicevalue": {"5",
                            "sayTexttext": "<p>Please rate the document you just viewed.</p>\n",
                            "rePromptdata": ""
                        },    
                    "chat": {],
                             "chatText"multiScreen": {
    ""                     }"description": "",
                        "screenvalidation": {
                            "shortTitlevalid": "",
                            "longTitleinvalid": "",
                            "body": "",
       },
                        "smallImagevoice": "",{
                            "largeImagesayText": ""<p>Please rate the document you just viewed.</p>\n",
                  }          "rePrompt": ""
         },               },
     "directives": {
                        "micInputchat": true,{
                         "keyboardInput   "chatText": true,""
                        "waitTimeNoAnimation": false},
                        "endSessionscreen": false{
                    }        "shortTitle": "",
       },             {          "longTitle": "",
          "key": "649811202072708483",                 "namebody": "Yes/No",
                            "descriptionsmallImage": "Was this tutorial helpful?\n","",
                            "typelargeImage": "boolean",
                    "category": "",   }
                 "loc": "232.52284749830793 460.08626557842007"   },
                    "yesDataLabeldirectives": "Yes", {
                        "noDataLabelmicInput": "No",true,
                        "yesDatakeyboardInput": "",true,
                        "noDatawaitTimeNoAnimation": ""false,
                        "multiScreenendSession": {false
                     }
      "description": "",         },
               "validation": {
     
                          "valid"key": "649811202072708483",
      
                         "invalidname": "Yes/No",
                        },
       "description": "Was this tutorial helpful?\n",
                    "voicetype": {"boolean",
                    "category": "",
          "sayText": "<p>Was this tutorial helpful?</p>\n",      "loc": "232.52284749830793 460.08626557842007",
                    "rePromptyesDataLabel": "Yes",
                    "noDataLabel": "No",
      },              "yesData": "",
         "chat": {          "noData": "",
                    "chatTextmultiScreen": {
    ""                     }"description": "",
                        "screenvalidation": {
                            "shortTitlevalid": "",
                            "longTitleinvalid": "",
                            "body": "",
       },
                        "smallImagevoice": "",{
                            "largeImagesayText": ""<p>Was this tutorial helpful?</p>\n",
                     }       "rePrompt": ""
            },            },
        "directives": {               "chat": {
        "micInput": true,                     "keyboardInputchatText": true,""
                        "waitTimeNoAnimation": false},
                        "endSessionscreen": false{
                    }        "shortTitle": "",
       },             {          "longTitle": "",
          "key": "185352052922068022",                 "namebody": "Say",
                      "description": "Thats sad. Please leave a comment on the document on what can be improved.\n",      "smallImage": "",
                            "typelargeImage": "message",
                      "category": "", }
                   "loc": "382.52284749830795 658.3390498084344" },
                    "multiScreendirectives": {
                        "voicemicInput": {
      true,
                         "sayTextkeyboardInput": "<p>Thatstrue,
    sad. Please leave a comment on the document on what can be improved.</p>\n"        "waitTimeNoAnimation": false,
               },         "endSession": false
              "chat": {     }
                },
          "chatText": ""     {
                   } "key": "185352052922068022",
                  }  "name": "Say",
             }         ],
            "linkDataArray"description": ["Thats sad. Please leave a comment on the document on what can  {be improved.\n",
                    "fromtype": "857428463371497251message",
                    "tocategory": "742436401836062521",
                    "fromPortloc": "OUT382.52284749830795 658.3390498084344",
                    "toPortmultiScreen": "IN", {
                        "pointsvoice": [{
                        232.52284749830798,    "sayText": "<p>Thats sad. Please leave a comment on the document on what can   be improved.</p>\n"
     110.15531692504884,                   },
     232.52284749830798,                   "chat": {
    120.15531692504884,                     232.52284749830798,   "chatText": ""
                    147.68120307922365,    }
                    232.5228474983079,}
                }
           147.68120307922365 ],
            "linkDataArray": [
              232.5228474983079,  {
                    "from":  175.20708923339845,"857428463371497251",
                    "to": "742436401836062521",
       232.5228474983079,             "fromPort": "OUT",
          185.20708923339845          "toPort": "IN",
         ]           "points": [
    },             {       232.52284749830798,
             "from": "742436401836062521",          110.15531692504884,
          "to": "649811202072708483",             232.52284749830798,
       "fromPort": "OUT",                 120.15531692504884,
     "toPort": "IN",                 "points": [ 232.52284749830798,
                        232147.522847498307968120307922365,
                        318232.459873463412755228474983079,
                        232147.522847498307968120307922365,
                        328232.459873463412755228474983079,
                        232175.522847498307920708923339845,
                        355232.95987346341285228474983079,
                        232.5228474983079,185.20708923339845
                    ]
         355.9598734634128,       },
                {
    232.5228474983079,                "from": "742436401836062521",
       383.4598734634129,             "to": "649811202072708483",
          232.5228474983079,          "fromPort": "OUT",
             393.4598734634129       "toPort": "IN",
            ]        "points": [
       },             {    232.5228474983079,
                "from": "649811202072708483",       318.45987346341275,
             "to": "417833740235547202",           232.5228474983079,
         "fromPort": "Yes",              328.45987346341275,
      "toPort": "IN",                 "points": [232.5228474983079,
                         292355.633061731706339598734634128,
                        526232.71265769342725228474983079,
                        292355.633061731706339598734634128,
                        536232.71265769342725228474983079,
                        292383.633061731706334598734634129,
                        554232.21265769342715228474983079,
                        107393.52284749830794,4598734634129
                    ]
       554.2126576934271,         },
               107.52284749830794, {
                       571.712657693427"from": "649811202072708483",
                        107.52284749830794"to": "417833740235547202",
                    "fromPort": "Yes",
      581.712657693427              "toPort": "IN",
     ]             },  "points": [
             {           292.63306173170633,
         "from": "649811202072708483",              526.7126576934272,
      "to": "185352052922068022",                 "fromPort": "No"292.63306173170633,
                    "toPort": "IN",   536.7126576934272,
                 "points": [       292.63306173170633,
                        140554.98620351637432126576934271,
                        526107.712657693427252284749830794,
                        140554.98620351637432126576934271,
                        536107.712657693427252284749830794,
                        140571.9862035163743712657693427,
                        554107.212657693427152284749830794,
                        382581.5228474983081,712657693427
                    ]
       554.2126576934271,         },
               382.5228474983081, {
                       571.712657693427"from": "649811202072708483",
                    "to": "185352052922068022",
      382.5228474983081,              "fromPort": "No",
         581.712657693427           "toPort": "IN",
        ]             },"points": [
                {        140.9862035163743,
            "from": "185352052922068022",           526.7126576934272,
         "to": "402026513763859450",              140.9862035163743,
      "fromPort": "OUT",                 "toPort": "IN",536.7126576934272,
                       "points": [ 140.9862035163743,
                        382554.52284749830812126576934271,
                        714382.96544192344135228474983081,
                        382554.52284749830812126576934271,
                        724382.96544192344135228474983081,
                        382571.5228474983081712657693427,
                        752382.49132807761615228474983081,
                        232581.52284749830798,712657693427
                    ]
        752.4913280776161,        },
                232.52284749830798,{
                    "from": "185352052922068022",
      780.0172142317911,              "to": "402026513763859450",
         232.52284749830798,           "fromPort": "OUT",
            790.0172142317911        "toPort": "IN",
           ]         "points": [
      },             {     382.5228474983081,
               "from": "417833740235547202",        714.9654419234413,
            "to": "402026513763859450",           382.5228474983081,
         "fromPort": "OUT",              724.9654419234413,
      "toPort": "IN",                 "points": [382.5228474983081,
                         107752.522847498307944913280776161,
                        714232.965441923441352284749830798,
                        107752.522847498307944913280776161,
                        724232.965441923441352284749830798,
                        107780.522847498307940172142317911,
                        752232.491328077616152284749830798,
                        232790.52284749830798,0172142317911
                    ]
       752.4913280776161,         },
               232.52284749830798, {
                       780.0172142317911"from": "417833740235547202",
                        232.52284749830798"to": "402026513763859450",
                    "fromPort": "OUT",
                790.0172142317911    "toPort": "IN",
               ]     "points": [
          }         ]     },107.52284749830794,
             "utterances": []
    }
    
    • A Flow studio conversation similar to the one in the below screenshot will be imported.

    ...

               714.9654419234413,
                        107.52284749830794,
                        724.9654419234413,
                        107.52284749830794,
                        752.4913280776161,
                        232.52284749830798,
                        752.4913280776161,
                        232.52284749830798,
                        780.0172142317911,
                        232.52284749830798,
                        790.0172142317911
                    ]
                }
            ]
        },
        "utterances": []
    }
    
    • A Flow studio conversation similar to the one in the below screenshot will be imported.

    ...

    Step 2: Connect Your Conversation to Experience Designer

    ...

    1. Copy the FlowID at the top of your new flow.

    ...

    You can also copy the FlowID from the verticle ellipses dropdown menu too.

    ...

    2. Open Experience Designer by navigating to your side menu > Develop > Experience Designer.

    ...

    3. Click on the (plus) icon in the tabs menu. We will add a new tab and name it “Flow Manager”Flow Manager.

    ...

     a. Double click on the flow to rename it and click on Done.

    ...

    4. Click on the hamburger icon > Import > Built-in > Orbita Flows-(BETA) > FlowManager

    ...

    6. Double click on the Function node named “Set Flow Id.

    7. Locate msg.payload.flowId = '' and paste the FlowID you copied within the single quotes and click Done.

    ...

    To create a Dialogflow account and publish the interaction model to Google Dialogflow, make sure you complete the steps in this document:How to Publish the interaction model to Dialogflow?.

    After successfully deploying the interaction model to the Dialogflow Agent,

    1. Go to the Experience Designer > Launch tab > Launch node > EndpointEndpoint.
      Click on the icon at the end to copy the endpoint address.

    2. This URL is used as a webhook URL for Alexa and Dialogflow.
      For Dialogflow, go to https://dialogflow.cloud.google.com/ and select Fulfillment from the side menu. Enable Webhook and use this URL to link the Dialogflow agent with the Orbita project.

      Image RemovedImage Added

    3. You have successfully connected the project with your Dialogflow agent.

    ...

    You can access and test your new chatbot in two ways:

    A. Using the

    ...

    URL Endpoint

    https://<domain-name>.orbita.cloud:8443/oeapi/bot/yourbot

    B. Using the

    ...

    “Bot Manager” Flow

    ...

    Tab

    A Bot Managerflow tab is available in every new project you create

    ...

    and allows you to have an endpoint for your chatbot.

    • Navigate back to

    ...

    ...

    Your new chatbot will launch with the default phrase “Hello, Welcome to your first Project.” This is because our “Launch” button is connected to

    ...

    • your Orbita project and open your Experience Designer.

    • Go to your “Bot Manager” tab open the ‘Http in’node named “GET“ that is connected to the ‘Bot View Template’ node and click on the Open/Copy URL button. This will open up your chatbot in a new window.

      Image Added

    • Your new chatbot will launch with the default phrase “Hello, Welcome to your first Project.”

      Image Added

    • This is because by new project defaults, our ‘Launch’ node right now is connected to the ‘Say’ node in our “Launch” tab within Experience Designer.

    ...

    Info

    Learn about the different Experience Designer nodes here: 3.1.5 Default Nodes in Experience Designer.

    • To invoke your new Flow Studio conversation, you can type in the utterances “flow” or “flow studio” in the chatbot.

    ...

    • If you want to

    ...

    • directly launch your own Flow studio conversation,

    ...

    • add a ‘Launch’ node to the “Flow manager” tab and connect it to the ‘Set Flow Id’ node, as shown below.

    ...

    • Delete the ‘Launch’ node from the “Launch” tab and hit Deploy.

    • Now when you

    ...

    • refresh the

    ...

    • chatbot URL, your first message from your Flow Studio conversation should launch directly.

    ...

     

    Note

    Make sure you delete the Launch node from the Launch tab

    Refer to this document for detailed configuration steps. How do I configure ChatbotYou have successfully created your first chatbot!

    Video Content

    https://cdn.orbita.cloud/assets/orbita/general/createfirstchatbot.mp4