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.
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
Width: the
x_konve_kbot_test.kbot.widget.width
parameter.Height: the
x_konve_kbot_test.kbot.widget.height
parameter.Chat window position:
Title background color: the
x_konve_kbot_test.kbot.widget.color_title_bg
parameter.Title text color: the
x_konve_kbot_test.kbot.widget.color_title_text
parameter.Resize button text: the
x_konve_kbot_test.kbot.widget.label_resize
parameter.Close button text: the
x_konve_kbot_test.kbot.widget.label_close
parameter.Minimize button text: the
x_konve_kbot_test.kbot.widget.label_minimize
parameter.Refresh conversation on close:
x_konve_kbot_test.kbot.widget.refresh_on_close
parameter.Make the chat modal:
Button appearance
Button text: the
x_konve_kbot_test.kbot.widget.label_button
parameter.Button tooltip:
x_konve_kbot_test.kbot.widget.label_tooltip
parameter.Button background color: the
x_konve_kbot_test.kbot.widget.color_button_bg
parameter.Button background color on hover:
Button text color: the
x_konve_kbot_test.kbot.widget.color_button_text
parameter.Button background color on hover:
Button position: the
x_konve_kbot_test.kbot.widget.button_position
parameter.Tooltip hide timeout:
Display the button icon:
Hide button:
x_konve_kbot_test.kbot.widget.buttonInvisible
parameter.Widget icon file:
x_konve_kbot_test.kbot.widget.iconUrl
parameter.
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:
Application = "Virtual Agent for IT Service Desk"