Last updated 4/5/20242 minutes to read

Web Assistant

Sonat's Web Assistant is a powerful tool designed to, Quick and easy access to information, Personalized assistance, and Improved user experience.

To access web assistant settings:

  •  On your homepage, Click three vertical lines at the top.
  • Click Organizations Settings.
  • Under the web assistant tab, you can customize its settings.

Activate Web Assistant

To start with Sonat's Web Assistant, activate it from your organization's settings. This is where you can enable the Web Assistant feature and customize its settings according to your needs.

After enabling it, you can copy the provided code and place it on your application's root page.

Button Text

The Web Assistant feature includes a customizable button text, which appears on your documentation website. You can choose any text you prefer.

Please note that we have two types of web assistants available. The first type is the popup assistant, which is currently in use. With this type, the button text is not displayed. 
The second type is the slider assistant, which appears like a panel. Because this panel is wider, we can use both an icon and button text.

Assistant's Base Page

You can also set one of your documents as your Web Assistant's starting page.

Trigger with JavaScript

Sonat's Web Assistant allows you to dynamically open and close its panel using the "data-swa-paneljstrigger" attribute in conjunction with JavaScript. This feature provides a seamless way to integrate the Web Assistant functionality into your web application. Below is a more detailed explanation of how to use these triggers:

Attribute Usage:

Apply the "data-swa-paneljstrigger" attribute to the HTML element that should trigger the Web Assistant panel.

Upon clicking the designated element, the Web Assistant panel will be triggered to open. This functionality is designed to work across all panel types, providing flexibility in your user interface.

Example:

Consider the following HTML code, where a button is assigned the "data-swa-paneljstrigger" attribute:

<button data-swa-paneljstrigger>Click me to open Web Assistant Panel!</button>

Target Element Selector

When selecting "Embed" as your web assistant type, you have the ability to define the target element on your web page where the assistant will be embedded. To achieve this, you can specify the target element by writing its selector in the designated field. This allows you to control the placement of the web assistant, ensuring it appears exactly where you want it on your page.
 

Styling

  • To give your Web Assistant a unique look, you can customize its styling settings. This includes changing the background, button, and font colors to match your website's branding.
  • By panel type option, you can have a Slider or Pop-over button. 
  • You can also change the position of your button to the left and right by using the position option.
  • To change the icon of your web assistant, just delete the current icon by clicking on the trash button. And then, choose your desired icon.
  • You can check a preview of your customized style at the bottom of this page.
Introduction