Design Knowledge Center Bots (Beta)
This article explains how to customize the appearance of the Knowledge Center Bot in Gainsight PX.
Overview
The Design section of Knowledge Center Bot (KC Bot) allows you to customize the bot's appearance to align seamlessly with your organization's branding and application interface. It helps you create a personalized and professional look and feel for the bot that enhances the overall user experience.
You can configure various design elements, such as the bot's position, choose themes, colors, typography, and layout options. Additional customization includes selecting icons and corner designs, ensuring a cohesive and visually appealing integration with your application.
Prerequisites
Ensure that you have Editor access to Knowledge Center to create KC Bots and articles, and Manager or Production Launcher access to launch the bot. For more information on assigning user permissions, refer to the User Management article.
Design Knowledge Center Bot
The Design section of KC Bot configuration allows you to tailor the look and feel of the bot, across various visual elements visible to the end-user.
To design a bot:
- Navigate to Knowledge Center Bot from the main menu. The Knowledge Center page appears.
- Create a new bot or edit an existing one.
- Click the Design icon. The following sections are available to customize:
Configure the Position of KC Bot
Use the Position section to configure the bot's placement on the screen, how it opens, and more.
Bots can be triggered in one of the following ways:
- Widget Bot: Activates upon user interaction with the bot widget, providing a floating widget that appears over your web page or application.
- Embedded Bot: Integrates directly within your application's user interface, requiring the bot to be mapped to specific UI elements for activation.
Note
- Gainsight PX supports a single active bot per active user at a time based on the bot segmentation and priority. If you have configured two or more active widgets or embedded bots, the bot with the highest priority is displayed.
- A default expand and collapse icon appears in the bot header, allowing users to toggle the view for better readability and a cleaner interface.
Launch KC Bot from the Bot Widget (Widget Bot)
The bot widget is a floating element that appears over your application, allowing users to access relevant resources from anywhere, without leaving their workflow.
To configure the bot widget:
- Expand the Position section.
- Select the Open from a widget/badge option.
- In the User Control section, turn off the Draggable toggle if you wish the bot widget to be fixed at one place. By default, the toggle is on, allowing users to move the bot icon if it covers important UI elements such as CTA buttons.
- In the Position on Screen section, select on which side of the screen the bot must appear to users on your application.
- (Optional) Click Advanced Position Settings to manually adjust the widget’s position with respect to the screen edges, for precise placement. The following configurations are available:
- Horizontal Offset: Define the space from the bottom of the screen and the widget.
- Vertical Offset: Configure the space from the right or left edge of the screen and the widget, depending on the position selected.
- Custom Z-Index: Controls the layering position of the widget on the page. A higher z-index value places the widget above other elements, ensuring it stays visible over items such as buttons or notification centers. A lower value may cause the widget to appear behind those elements.
- Click Save.
Launch KC Bot from a UI Element (Embedded Bot)
Knowledge Center Bot can be launched from a specific UI element within your application. This approach integrates the bot directly into your interface, requiring it to be mapped to a chosen element, and provides a seamless way for users to access support in context.
Business Use Case: A product has a dedicated section for users to access help or documentation, and it is important that this section blends into the UI without additional visual elements such as badges. Instead of using the default bot widget, the KC Bot can be embedded into a specific UI element, such as a help icon or link, so it launches contextually when needed. This keeps the interface clean and focused, while still offering users quick access to relevant content.
Note: Embedded bots do not work in an iframe.
To configure the embedded bot:
- Expand the Position section.
- Select the Open from an UI element option.
- In the CSS Selector field, enter the CSS element of the UI item on which you need to embed the bot. Ensure that the CSS selector is unique.
- In the Position on Screen section, configure the following:
- Grid: Select the position where the bot must appear with respect to the selected UI element.
- Anchor Position: Configure the direction in which the bot opens, with respect to the UI element. You can select from left/right and top/bottom options.
- Custom Z-Index: Controls the layering position of the widget on the page. A higher z-index value places the widget above other elements, ensuring it stays visible over items such as buttons or notification centers. A lower value may cause the widget to appear behind those elements.
- (Optional) Click Advanced Position Settings to manually adjust the bot’s position with respect to the UI element, for precise placement. The following configurations are available:
- Horizontal Offset: Define the horizontal distance from the UI element and the bot.
- Vertical Offset: Configure the vertical space between the UI element and the bot.
- Position Type: Select the type of positioning from one of the following:
- Injection: PX injects the iFrame of the KC widget into the DOM element, while embedding the bot. While scrolling, the KC widget scrolls instantly with the page.
- Absolute: Render the bot at fixed X and Y coordinates, relative to the document, without affecting the DOM. While scrolling, the KC widget moves with the page scroll if it is associated with an outer scroll. For inner scrolls like a sidebar, the floating element does not move.
- Fixed: Render the bot at fixed X and Y coordinates, relative to the window, without affecting the DOM. While scrolling, the KC widget does not move instantly with respect to the page.
Note: The presence of a hidden overflow property (overflow: hidden;) in any of the parent DOM elements may affect how the bot is displayed.
- Click Save.
Design the Theme of the Bot
The Theme section enables you to customize the bot's visual style to ensure the bot aligns with your brand's identity. Customization options include configuring accent and background colors, text colors for headers and body, typography settings, and more.
The following configurations help ensure the bot feels native to your interface and visually consistent with your product design:
Section |
Description |
Customizable Options |
---|---|---|
Colors |
The primary visual identity of the bot. These colors influence the bot's overall aesthetics and ensure it complements your brand’s theme. Choose from the available colors, or click the pencil icon for a custom color. |
|
Text Colors |
The header and body text colors to enhance readability, and create a clear visual hierarchy. |
|
Typography |
The text styles for the header and body to establish a consistent look and tone of the content. |
|
Card Colors |
Define the visual style of content cards to ensure they provide a visually distinct experience. |
|
Corners |
The shape of the bot's edges to add a subtle yet impactful customization that can make the bot feel modern. |
|
Spacing Between Widgets |
The vertical spacing between widgets to best suit your design needs. |
|
Configure Icons of a KC Bot
The Icons section allows you to personalize the visual representation of the bot by customizing badge, close, and various function-specific icons to ensure the bot’s interface is intuitive, thus enhancing its usability.
Section |
Description |
Customizable Options |
---|---|---|
Badge Icon |
The entry point to the bot, appearing on your application to give end-users access. This can also be used by users to drag bot around the application. Note: Only applicable if the bot opens from the widget. |
Select a badge icon from the available options, or upload a personalized icon. |
Badge Close Icon |
The close icon appears when the bot is open, allowing end-users to dismiss the bot. |
Select a badge close icon from the available options, or upload a personalized icon. |
Type Icons |
Type icons represent specific content types or icons used in the Bot, such as search, guides, surveys, or articles. |
Leave the default icon selection, or upload personalized icons for the required ones. |
Note: The out-of-the-box icons automatically use the theme colors configured. However, custom icons do not inherit the theme colors and are used in its original colors.