Chatbot Settings

Owned by Rajkiran Alla (Deactivated)
Last updated: Oct 21, 2022 by Bharathi Manohar (Unlicensed)
6 min read

Chatbot Settings enable you to control some of the customizable chatbot features such as setting waitTime between bubbles, loading the chatbot from the bottom or top, changing the banner content, customizing the menu options, and so on.

You can change the Chatbot Settings at the Project side menu > Develop > Chatbot settings.

We have the option to add multiple Bot settings. Default Bot settings will be created in the project and cannot be deleted or edited. The default bot settings will have the Orbita tag on it. The User can create custom Bot settings, which can be deleted. It is advised to name the Bot settings title with Alphanumeric characters only.

Default bot settings and Copy of bot settings

All the properties listed below should be used under the appSettings property.
For example, to change waitTime to 250 ms, you have to use "waitTime": 250 as shown below.

On the Chatbot settings page, If any default property is deleted, it will be restored.

To restore all the default properties, you have to use an empty object {} and save it.

When changing the Relative path to Absolute path in the Settings tab for properties like the {{settings.header.logoUrl}} , please remove the {{cdnpath}} property added to the src='{{cdnpath}}{{settings.header/logoUrl}}' in the Template tab also.

Template

The HTML template for the v3 chatbot should be provided in the Template header in Chatbot Settings, which will help in rendering the bot on the web page.

  • The properties from the Settings tab can be accessed in Template. Example: {{settings.header.logoUrl}} By default, the handlebar built-in functions are supported. Example: using If conditions for DOM elements.

  • The bot will render inside the chatWindow element and all the styles are applied based on chatWindow element id (scoped styles). In case if you want to change the element id ‘chatWindow’ please make appropriate changes in the styles. <div class='orbita chat-container' id='chatWindow'>

  • The CDN path is defined as https://cdn.orbita.cloud/bot/{{version}}/{{settings.header.property}}

For sample: https://cdn.orbita.cloud/bot/v4096/chatbot/v2/assets/branding-mark.svg

 

For existing customers,
1. The contents from the settings tab in the Bot view template node takes higher priority.
2. Delete the contents of the settings tab in the Bot view template in Experience Designer, to load the Chatbot Settings for that project.

For new customers, by default, the Chatbot settings will be loaded for the project.

Settings Properties

Property

Description

Property

Description

"accordionBodyLineLength" : 4

This property defines the size of the content to display in the Accordion of the Card Directive. The number represents the number of lines to display

speechToText: "native"

Defines the Speech-to-Text converter to be used by the chatbot application and it takes values such as native, default, and google.

"audio": false

Defines if the Speaker icon should be visible in the Bot UI. False, will remove the Speaker icon. True, will display the Speaker, enabling the user to mute/ unmute.

"peekview": true

Defines if the Bot should load in Peek View on the host page.

"autoFocus": false

When false, the chatbot's focus remains on the action item unless manual input is made. If true, the focus is automatically managed.

"speechToTextLanguage": "Language Code"

Defines the Speech-to-Text language to be used by the chatbot application.
Refer, https://cloud.google.com/text-to-speech/docs/voices for the Language Code.

waitTime: "250"

Defines the amount of time (in milliseconds) the bot waits before showing the next bubble. Also, see

micMode: "push"

Setting this property to push will not enable the mic when the chatbot loads. The chatbot user has to manually enable the mic to use it.

Setting this property to auto will enable the mic when the chatbot loads. In short, a handsfree mode for the chatbot.

animationTime: "500"

(for buttons)

This property defines the amount of time (in milliseconds) the loading animation renders the buttons in the chatbot.

The animation time will kick in only when the chatbot’s scroll is visible i.e; when the chat bubbles occupy/fill the entirechatbot window.

The animation time is calculated based on the
animation_time * (number_of_bubbles /2)

startAlignmentTop: true

When this property value is set to true, the chat bubbles are loaded from the top of the chatbot first.

enablePreviousOptions: true

When this property value is set to true. The options displayed to the chatbot user will be visible highlighting the option chosen by the user.

waitSettings: {
mode: 'dynamic',
wpm: 165
}

This property introduces dynamic wait time based on the text in the previous chat bubble.
The mode can be dynamic or static.

  • If set to dynamic, the duration of wait time animation will be calculated based on the number of words rendered on the previous bubble. ((#of words in the last bubble ) / (Word Per Minute) ) * 1000

  • If set to static, the duration of wait time animation is taken from the property msg.payload.waitTime

More information at

logoutUtterance: "utterance"

When you click the logout button, the utterance set in this property will be passed to the server.

logoutUrls: "URL"

This URL will be called when the chatbot user clicks on the logout button.

logoutText: "text"

You can rename the logout button using this property

keyboardPlaceholderText: "Placeholder text"

The text passed in this property is displayed in the keyboard input box.

rePromptWaitTime: "500"

Defines the amount of time (in milliseconds) the chatbot waits before saying the reprompt question.

You can use the reprompt wait time by assigning a value greater than zero.

  • If the rePromptWaitTime property is not set, it will take the default value as zero.

  • If the rePromptWaitTime property is already set to a positive value, it will be maintained after the upgrade.

Note: Reprompt works only if the original question is not answered yet.

offlineMessage : 'You lost your Internet connectivity'

The message that is displayed when the chatbot user is offline. You cannot do any action in the chatbot when offline.

onlineMessage : 'You are online'

The message that is displayed when the chatbot user is back online.

"banner": {"title":"","message":""}

The message can hold HTML links, content for the banner.

"peekview":true

Peek View is a new feature for ChatBot V3. The virtual assistant appears to be partially open and some of the messages get displayed. The Peek view changes to the Dock view after the user interacts with the buttons/input elements, and the interaction continues. Peek view support is offered for monitors, tablets, and mobile devices.

"peekview":true property should be set in the ChatBot settings to enable this view. By default, it is set to false.

"botHost": "https:example.com/"

Defines the Host domain of the Chatbot. This property will help us use assets, and define CSS from the hosting page in our Template tab.
For example to access an image in the Template tab, use {{settings.appSettings.botHost}}/brand-logo.png to access it.

"welcomeMessage": {         "value": "HTML content"     }

 

Defines the content to show in the Header section. This can bare HTML content, Text, emoticons etc. This is specific to V3 Bot.

"botAvatarUrl":"/chatbot/v2/assets/orbita-icon.svg"

Defines the Bot Avatar image location. By default it loads the Orbita Logo using the CDN relative path, /chatbot/v2/assets/orbita-icon.svg We can define the CDN path to the Avatar Icon or provide the absolute path of Client branding icons.

 

Related Articles