This page describes how to create a widget for your ServiceNow environment , and how to keep the previously configured settings in case you are migrating from older widget versions.
| Table of Contents | ||||
|---|---|---|---|---|
|
Key points
To add a widget on your ServiceNow portal:
In Kbot, create and configure a widget.
In ServiceNow, enable the widget by setting the host and the widget ID.
Creating a widget
To configure your widget, go to Configuration > Widget on your Kbot host and set the parameters.
General settings
Name: enter the name of your widget.
Description: enter the description.
Application: select the application type for your widget.
...
Widget appearance and behavior
...
For more details on parameters, view this help page.
| Info |
|---|
In case you are migrating from old version of widget to the new one, you might want to keep the parameters you have defined earlier. To do so, you need to export the properties from the |
Copying ID
Click Save and copy the widget ID — you will need to enter it in ServiceNow later. The ID is available in the browser address bar (the last value after /), or in the Code for embedding area on the right side of the window.
...
Enabling the widget in ServiceNow
In ServiceNow, go to Virtual Agent for IT Service Desk > Properties and enter the host for your Kbot application and the widget ID.
...
Migrating from old widget
In older widget versions, you had to set the widget configuration in your ServiceNow environment:
...
In case you are migrating from an old version of widget to the new one, you might want to keep the parameters you have defined earlier. To do so, export the properties from the sys_properties table:
| Code Block |
|---|
Application = "Virtual Agent for IT Service Desk" |
...
Setting | Parameter |
|---|---|
Widget width |
|
...
Widget height |
|
...
Title background color |
...
|
...
Title text color |
...
|
...
Text of the “resize” button |
|
...
Text of the “close” button |
|
...
Text of the “minimize” button |
|
...
Refresh conversation on close |
...
|
...
Button appearance
...
...
Make the chat modal:
Text of the widget button |
|
...
Button tooltip |
...
|
...
Button background color |
...
|
...
Button |
...
text color |
...
...
|
...
Button |
...
position |
|
...
Tooltip hide timeout:
...
Display the button icon:
...
Hide button |
|
...
Widget icon file |
...
|
...
Enabling the widget in ServiceNow
In ServiceNow, in the widget properties view, enter the host for your Kbot application and the widget ID.
The direct link is (make sure to change <your-host>):
https://<your-host>.service-now.com/now/nav/ui/classic/params/target/system_properties_ui.do%3Fsysparm_category%3DKbot%2520Connection%2520Properties%2CKbot%2520Widget%2520Properties%2CKbot%2520Debug%2520Properties%26sysparm_domain_restore%3Dfalse%26sysparm_stack%3Dno%26sysparm_title%3DProperties
...
Previously, you had to set the widget configuration in your ServiceNow environment. The old widget settings UI in ServiceNow contained actual settings:
...
Migrating from old widget
In case you are migrating from old version of widget to the new one, you might want to keep the parameters you have defined earlier. To do so, export the properties from the sys_properties table:
| Code Block |
|---|
Application = "Virtual Agent for IT Service Desk" |
...