Configuring the widgets for Serviceware Knowledge
All the parameters that can be used to design the Knowledge widgets in the Serviceware Portal and fill them with content are described in the following section.
A description of the parameters is also available via tooltips. Each of the parameters for the widgets is described once only.
General parameters
- Widget group
- Grouping of the widgets. Widgets from the same group can communicate with each other. The widgets that should communicate with each other must be assigned the same number.
- Respond to events from other widgets
- activated: The widget reacts to events from other widgets, for example, displaying a result list from the Suche widget.
- Configuration is editable at runtime
- activated: The configuration of this widget can be edited at runtime.
- Trigger events for other widgets
- activated: Other widgets react to events of this widget, for example, displaying search results from the Suche widget.
- Number of items per page
- Number of search hits displayed in the Result list.
Dialog parameter
- Display as dialog
- activated: The contents of the widget are displayed in a dialog. More configuration options are available
- Title in dialog box
- Title to be displayed in the dialog box.
- Text in dialog box
- The text in the input field is displayed below the title in the dialog box.
- Size of dialog box
- Size of the dialog box in pixels, for example 1200x700.
Display parameters
- Placeholders
- Placeholder text which is to be displayed in the field as long as no content has been entered in the field.
- Visible
- activated: The widget is displayed.
- View mode
- Display mode: View is selected via a drop-down list.
- Filters and values may be grouped by color
- enabled: establishes a color grouping of filters and values.
- Allow only certain filters
- Definition of the filters that will be displayed in the Filter widget. You can open the filter list using the plus key and select the desired filters.
- Hide column names
- activated: The table columns are displayed without a heading.
- Alternative text in case of search without results
- If no search results are found, a predefined text can be displayed.
- Column names
- Select the table columns to be displayed in the results list.
- Highlight search hits
- activated: the search terms are highlighted in the hit list.
- Display paging
- enabled: the information on the number of entries per page as well as the number of pages is displayed below the hit list.
- Page length adjustable
- activated:
Navigation parameters
- Allow navigation
- activated: A parameter (a displayed content, navigation element) is passed to the URL for loading the texts.
Behavior of the widget Search
- Initial search for
- Search term that triggers an initial search.
- Search provider
- Selection of a search provider from the drop-down list (Elastic Search, AI).
- Maximum number of results shown
- Specify the maximum number of search results shown.
- Search filter
- Alternative to the widget Filter.
- Filter is leading
- activated: The filter is always applied and cannot be canceled by selecting a filter in the widget Filter.
Suggestions within the widgets Search and Automatic search
- Show search suggestions
- activated: Search suggestions are displayed when the search term is entered.
- Behavior of search suggestions
- text-based: Default behavior for widgets is suggested in word-based form within Serviceware Knowledge.
- Show selected suggestions only
- activated: Together with parameter Show search suggestions enabled, only the selected suggestion will be displayed in the details view. The hit list will not be filled.
- Minimum number of characters
- The number of characters that must be entered in the search field to trigger the search suggestions.
- Number of search suggestions
- Maximum number of search suggestions displayed in the search suggestions drop-down list.
- Delay time in ms
- Time in milliseconds between the last keystroke and the start of the search.
- IDs of the initially displayed texts
- One or more contents may already be suggested before the first search via the result list.
- Content selector (CSS selector)
- Input of a CSS element as search base, for example text area for searching within texts.
- Wait for target element
- activated: Select this option if the CSS element pointed to by the content selector is not initially available on the pages, but is dynamically generated.
Behavior of the widget Filter
The following parameters can also be set for the behavior of the Filter widget:
- Merge possible filters
- Load possible filters initially
- Selection of filters that are already loaded when the widget is opened.
- Apply filter for
- Drop-down list of possible events to which the filters can be applied.
Behavior of the widget Result lists
The following parameters can also be set for the behavior of the Result lists automatic search widget:
- IDs of the initially displayed texts
- One or more contents may already be suggested before the first search via the result list.
- Open text automatically with only one search result
- activated: If only one text is found via the search, the content is automatically displayed in the widget Detailed view.
Behavior of the widget Detailed view
- IDs of the initially displayed texts
- One or more contents may already be suggested before the first search via the result list.
- Collapse other items
- activated: Only one text element can be expanded, all other text elements are automatically collapsed.
- Expandable
- activated: Texts may be expanded and collapsed
- Expand expandable areas (foldouts) automatically
- activated: All text elements are expanded when the text is loaded.
Display behavior of the widget Detailed view
- Expanded
- activated: The text is expanded when being opened.
- Show text path
- activated: The path is displayed under the text title and may be used for navigation.
- Show attachments
- activated: When the texts is displayed, the attached documents are displayed also.
Behavior of the widget Tree (navigation)
- ID of the initially selected branch
- To start the search via the tree, a specific branch may be opened in the view.
- Selection of branches with sub-branches allowed
- activated: Selecting any node in the tree causes the corresponding text to load.
Display behavior of the widget Tree (navigation)
- Show first level branch
- activated: The tree structure is displayed in the widget starting from the first level of the tree, which is the root level.
- Input branch (ID)
- A particular branch may be specified as the start branch in the tree.
- Maximum tree depth
- Limitation of the tree depth. If a number of levels is entered, the tree depth is limited.