- 03 May 2023
- 3 Minuten zu lesen
- Aktualisiert am 03 May 2023
- 3 Minuten zu lesen
With Document360's URL mapping feature in Knowledge base assistant, you can display specific articles and categories depending on the page the end user is visiting with. You can also use URL mapping to hide the Knowledge base assistant on particular URLs or provide a search bar with a custom placeholder to point end users in the right direction of what to search.
Using URL mapping
A URL mapping is configured for a specific action within the Knowledge base assistant on a particular URL.
There are four different actions you can trigger within the Knowledge base assistant:
- Hide - The Knowledge base assistant icon will not display on the specified URL
- Single - A single article will display within the Knowledge base assistant on the specified URL
- List - A list of selected articles will display under a "Recommended" section within the Knowledge base assistant on the specified URL
- Search - You can set a specific search term to query your knowledge base and return a list of search results within the Knowledge base assistant on the specified URL
These actions can be found within the Add URL Mapping panel or when you edit an existing mapping.
There are three types of parameters you can include in the configuration of the Knowledge base assistant URL:
- Include Path:
- Include Query:
- Include Hash:
You can also include regular expressions in your URL by enabling the Is Regex toggle.
Setting up recommended articles and categories to display in the Knowledge base assistant
Go to Settings → Knowledge base assistant → URL mapping
Click New URL mapping on the top right
Enter the following:
Friendly Name - The URL Mapping name will only be shown on the URL mapping record within Document360
URL pattern - Select the desired URL parameter type (Include path/Include query/Include hash). You must enable at least one URL parameter
Type in the URL on which you want the article/category to show or action to occurYour domain name is not included in the URL path. For instance,
https://document360.com/ebook/rapid-guide-to-launch-your-knowledge-base/, your URL Path would be
Action - Select the desired action
Project version - Select the desired version (if you have multiple versions)
Language version - Select the desired language (if you have multiple languages)
Article - In the search bar, select the articles/categories you want to show from your knowledge base documentation
Folder categories are not available for selection. Only page and index category types are available for selection.
Suppose an end user accesses your specified URL path and opens the Knowledge base assistant; they will see the article/category you have mapped. The article/category will be retained even when you navigate between the Knowledge base assistant tabs within the same version and language.
Editing URL mapping
You can edit the already set URL mapping.
Go to Settings → Knowledge base assistant → Setup configuration
Hover over the desired Knowledge base assistant and click Edit
In the URL mapping tab, you can find the list of available URL mapping
Hover over the desired URL mapping and click the Edit icon
The Update URL mapping blade appears
Update the desired information and click the Update button
Deleting URL mapping
- Go to Settings → Knowledge base assistant → Setup configuration
- Hover over the desired Knowledge base assistant and click Edit
- In the URL mapping tab, you can find the list of available URL mapping
- Hover over the desired URL mapping and click the Delete icon
- Click Yes in the Delete confirmation prompt
Settings - URL mapping
You can define the Knowledge base assistant behavior for URLs that do not have mapping configured. Defining this behavior can improve the user experience and accessibility to the documentation.
- Go to the Installation & Setup tab of the desired Knowledge base assistant (Settings → Knowledge base assistant → Setup configuration)
- Under Set your controls, expand the Settings - URL mapping section
- Select the desired option:
- Navigate to the page help/knowledge base: Select this option to display the article/category in Page help or Knowledge base tab in the assistant
- Do not make any changes to the existing setup: Select this option to display the last opened article/category in the assistant
- Click Save