Integration of the Knowledge widgets into a web page

Create a script to include the Knowledge widgets in your website and assign properties to the Knowledge widgets.


Screenshot: Portal page with Serviceware Knowledge widgets
The Knowledge widgets allow you to access the information in your Knowledge system. The widgets map the search, filter, result lists and detail view functions, as well as the navigation via the tree.
Tip: When configuring the widget, note that it is not possible to switch views within the widgets. You can distribute information via a public view or via the logged-in users' own views.
To make the widget usable in a website, a configuration script must firstly be created, which is integrated into the HTML code of the website in the next step.
The widgets for the Serviceware Portal are configured in a similar way, but the configuration for this should nevertheless be carried out in the Serviceware Portal.
Warning: The parameters set here have no influence on the Portal widgets.
Proceed as follows to configure the widgets for your webpage:
API Key
Select the API keys from the drop-down list.
The API is used to define access to specific content.
Use authentication
Active: You use single sign-on with the Serviceware Authenticator for the authentication.

Screenshot: Embedding the widgets into Portal

You can configure the individual widgets in the lower area of the screen. In three tabs, you can enter the parameters, see a preview and view the HTML source code of the widgets.

Proceed as follows to configure the widgets:

  1. Select the API key from the drop-down list.
  2. Choose whether user authentication should take place.
  3. Copy the script for embedding Knowledge widgets into the HTML source code of your website.
  4. Configure the individual widgets.
    1. Set the desired parameters.
    2. Check the settings in the preview.
    3. Open the HTML code to check it.
    4. Copy the code for the widget and paste it into the HTML source code of your website.
  5. Save the source code of your website.
You can use the configured widgets on your website.

You can embed the following widgets in your website.

Search

The Search widget allows you to search in the Serviceware Knowledge content by text input.

For more information on the behavior of the Search widget, see section Behavior of the widget Search.


The following parameters can be set additionally for the widget:

Automatic search

The Automatic search widget can be associated with a DOM element, then an automatic search for content can be carried out. This widget has no user interface.

For more information on the behavior of the Search widget, see section Suggestions within the widgets Search and Automatic search.

Screenshot: Configuring the automatic search widget

Numerous parameters may be set for the widget. Besides general parameters, there are specific parameters that are only applicable to individual widgets. These are linked in the corresponding sections. The tooltips give you information on the individual parameters.

Filter

The Filter widget enables the filtering of results found via the search and further narrowing the search.

For more information on the Filter widget behavior, see section Behavior of the widget Filter.
Screenshot: Filter widget settings

Result lists

The Results list widget displays the results found by the search.

For more information on the behavior of the widget for displaying the results lists, see section Behavior of the widget Result lists.
Screenshot: Settings for the results list widget

Detailed view

The Detailed view widget displays the knowledge content from the search, tree or result list.

For more information on the behavior of the widget for the detailed view of the content found, see section Behavior of the widget Detailed view and Display behavior of the widget Detailed view.

Screenshot: Settings for the details view widget

The following parameters can additionally be set for the behavior of the Details view widget for the automatic search: