/
Customizing a widget

Customizing a widget

When adding a widget to a portal page, you can use a Kbot floating button, or create a custom one. The latter allows you to fine-tune its position on the page and set the way it looks. You can also customize the widget to match the language of the user in the portal.

Customizing the widget button

Prerequisites

Before you start working on the custom button, make sure the following conditions are met:

  • Virtual Agent for IT Help Desk is installed on your ServiceNow instance.

  • The button is set for the whole portal.

References

  • To view the Kbot UI script, search for x_konve_kbot_test.KonversoWebChatWidget in ServiceNow.

  • To learn more about building custom widgets, view the official ServiceNow documentation.

Key points

To create a custom widget button:

  • Hide the default Kbot widget button.

  • Create a custom ServiceNow widget with a button.

Hiding the default button

To hide the default button, select the Hide button checkbox in the widget creation tool.

To view the complete set of widget options, see this page.

Creating a new widget

1. Open the Service Portal Configuration. To do so, either find Service Portal Configuration in the navigation tree, or go directly to https://<your-host>.service-now.com/sp_config.

2. Select Widget Editor.

3. Click Create a new widget.

4. Enter your widget name and ID. Enter a comprehendible name so you can find the widget in the list easily.

5. Set the following parameters for your widget:

HTML template

<div ng-click="c.showKbotWidget()" class="button_class"> <!-- your widget template --> My test widget to show dialog </div>

CSS-SCSS

.button_class { border: 1px solid red; background:green; color: white; }

Client script

api.controller=function() { /* widget controller */ var c = this; c.showKbotWidget = function() { Kbot.get().Widgets.execute('service-now-chat', 'showWidget') } };

You can find the widget ID (which is 'service-now-chat' here) in the UI script (replace the host in this link with your host), search for Kbot.get().Widgets.init (string number 170).

As a result, you should get the following:

  1. Save the widget.

Case of multiple widgets, same target host:

You need to ensure your two init functions:

Kbot.get().Widgets.initRemoteConfig('widget-id-value-1') Kbot.get().Widgets.initRemoteConfig('widget-id-value-2')

All you need to to have two distinct client scripts, each pointing to a different widget id.

api.controller=function() { /* widget controller */ var c = this; c.showKbotWidget = function() { Kbot.get().Widgets.execute('widget-id-value-2', 'showWidget') } };

Adding the widget to a portal

1. Open the Service Portal Configuration. To do so, either find Service Portal Configuration in the navigation tree, or go directly to https://<your-host>.service-now.com/sp_config.

2. Select Designer.

3. Search for Index — to add the widget to the main page of your portal.

4. Select the Index page.

5. Find your widget by entering its name in the search field in the upper left of the window.

6. Drag and drop it to the area where you want to place the button.

7. Save the changes.

Now you can click Preview to see how the page will look with the button.

Creating a widget supporting multiple languages

You can create a widget that automatically retrieves the language of the current ServiceNow user profile in order to :

  • ensure that the tooltip displayed above the widget button when closed is in the correct language.

  • make sure that when you open the widget, the bot is initialized in that same language (so the welcome message, buttons, etc. will be in that language).

You can follow the procedure below to create such a widget:

1. Open the Service Portal Configuration. To do so, either find Service Portal Configuration in the navigation tree, or go directly to https://<your-host>.service-now.com/sp_config.

  1. Select Widget Editor.

  1. Click Create a new widget.

  2. Enter your widget name and ID. Enter a clear name so you can find the widget on the list easily.

  3. Set the following parameters for your widget:

Client script

function KbotInit(settings) { // Kbot object initialization console.log("Settings:", settings); Kbot.init({ baseUrl: settings.baseUrl }); // The Chat widget initialisation Kbot.get().Widgets.initRemoteConfig(settings.widget.id, { initData: { lang:settings.selectedLang} }); }

Server script

var settingsUtils = new x_konve_kbot_test.KonversoWidgetSettingsUtils(); data.settings = settingsUtils.getSettings(); data.settings.selectedLang = gs.getSession().getLanguage();

  1. Save the widget.