Versions Compared

Key

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

...

  1. Login to Orbita Portal.

  2. From the Global menu, click on Settings > Organization.

  3. In the Organization page, click on Application Settings.

    Image RemovedImage Added
  4. Paste your site’s domain name at the arrow mark (as shown in the below screenshot) and click on the tick at the bottom right corner.

...

The Chatbot will load as shown below.

...

Properties

...

and its usage

...

Property and its usage

Description

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>',

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 Orbita AI Platform URL

...

.

theme: 'dock-float',

The ‘themeproperty 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>

...

',

...

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

Code Block
dockDefaultAction: 'open',

The property value for oathuserverUrl’ should be a URL.

clientId: 'oath client ID',

The property value for

...

This will display a logo in the header of chatbot.

Code Block
logoUrl: '<URL to the logo>',

dockDefaultAction

...

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.

Chatbot Icon

You can set a customized chatbot icon on your website using the below property. Clicking on the chatbot icon will open the chatbot.

Code Block
"theme": { "dockFloat": { "buttonSrc": "URL of the image", "buttonTitle": "Hi There!" } }

...

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@130ff
showSpacefalse
sortmodified
typepage
reversetrue
labelsengage chatbot
cqllabel in ( "engage" , "chatbot" ) and type = "page" and space = "OCS"