Page Comparison

dockDefaultAction: 'open',

If you want the chatbot to open as you load the website, add the property dockDefaultAction and set the value to open.

If you don't use this property in the script, you have to click on the chatbot icon to open the chatbot.

This property is valid only for dock and dock-float themes.

domId: 'chatWindow',

The property value for ‘domId’ should be set as the same ‘<Unique ID>’ which is used in the div tag in Step1.

launchWord: 'open',

The property value for ‘launchWord’ can be set to any utterance to begin the conversation. The default value is ‘open’

name: '<chatbot name>',

The property value for ‘name’ will be assigned as the name of the Chatbot.

width: '<width in pixels>',

The property value for ‘width’ should be a numeric value. This field is for restricting the width of the chatbot window. (Not applicable for Inline view theme).

height: '<height in pixels>',

The property value for ‘height’ should be a numeric value. This field is for restricting the height of the chatbot window. (Not applicable for Inline view theme).

serverUrl: 'https://<hostname>:<port>/oeapi/bot/web',

The property value for ‘serverUrl’ should be the Chatbot endpoint from Orbita AI Platform URL. Please refer How do I configure Chatbot for more information.

appSettingURL: 'https://<hostname>:<port>/oeapi/appsettings'

The app settings URL should be placed here. More information at App Chatbot Settings

theme: 'dock-float',

The ‘theme’property is valid only if the chatbot is plugged into a third party website. It is not applicable for chatbot rendered in a full window.

The theme can be dock, dock-float, inline, and sidebar.

enableLogin: true,

The property value for ‘enableLogin’ can be ‘true’ or ‘false’.

If enableLogin is set to ‘true’, a login link will appear for the end-user at the header of the chatbot. The chatbot would require the oath Server URL, Client ID and Client Secret to allow login functionality.

oathuserverUrl: ' https://<hostname>:<port>',

The property value for ‘oathuserverUrl’ should be a URL.

clientId: 'oath client ID',

The property value for ‘clientId’ should be the oath client ID obtained from the Orbita portal or third-party website.

clientSecret: 'oath client secret',

The property value for ‘clientSecret’ should be the oath client ID obtained from the Orbita portal or third-party website.

logoUrl: '<URL to the logo>',

he property value for ‘logoUrl’ can be a link to the image file.

This will display a logo in the header of the chatbot.