Chatbot

The USU Chatbot was formerly available only from KFirst widget. Now the chatbot is available as a single dashlet.

You can assign a Chatbot or a KFirst widget to a portal page. Unlike the other dashlets, the Chatbot and KFirst dashlet can only be added via the the Page designer.

In addition to the general attributes, you have the following configuration options:

Target

Target URL to fetch the ChatBot

To get the target URL do the following:

Open the Chatbot Manager
Choose or create a chatbot and open the details page
Go to Mandatory settings > Widget UI settings
Under Basic settings, copy the URL from the URL field
The URL should have /bot.html suffic

Add the target URL/path of the resource and define the request method.

Method

GET method retrieves data from the specified target
POST method creates/updates the specified target. The data sent to the target is stored in the Body attribute that is displayed after selecting the POST method.

Body Params/Body Edtior

Notice

The field is only available when the target method POST is selected.

Body Params
Define a key and value.
Click on to add another key and value.
Delete a key and value by clicking on the .
Body Editor
With the body editor you can create/edit the keys and values directly via JSON.

Basic functionality

When a portal page with the chatbot dashlet is loaded, the frontend sends a request to the backend
The backend uses variables from keycloak userId, firstName, lastName, email, username, fullName, locale
These values are sent to the Chatbot API, initializing variables for that specific chatbot

Using variables in dialogs

In the Chatbot Manager, you can use these variables in dialogs with the syntax: #{variableName}

Example: Hello #{firstName}, how can I help you?

Extend variables

You can extend the pool of variables that are initialized. These variables have to be defined in kc.chatbot.customAttributes.

Important

This has to be defined at deployment environment variable for backend. The value is a string separated by comma: company, telephoneNumber

Example: Hello #{firstName}, I'm #{firstName}'s chatbot, and I am here to assist you.

When using a search, the listener allows the Chatbot to respond automatically if it can help with the topic.

The chatbot offers his help via a message. The user can then click on the Chatbot to open it and use it accordingly.

Notice

The availability of this feature depends on the USU Chatbot version used.

The feature needs a USU Knowledge Center 7.3 and a configured USU Chatbot 2.9 installed and connected to USU Portal.

Notice

This feature is automatically available if a chatbot and a search is configured on a portal page.

In this section:

Chatbot

Notice

Important

Notice

Notice

Search results