URL mapping
  • 25 Jul 2022
  • 2 Minutos para leer
  • Colaboradores
  • Oscuro
    Ligero
  • PDF

URL mapping

  • Oscuro
    Ligero
  • PDF

There is no Spanish content available for this article, You are viewing the fallback version (English).

With the Knowledge base assistant, you can display specific articles and categories depending on the page the end-user is on with Document360's URL mapping feature. You can also use URL mapping to hide the Knowledge base assistant on a specific URL 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.

Actions

There are four different actions you can trigger within the Knowledge base assistant:

  1. Hide - The Knowledge base assistant icon will not display on the specified URL
  2. Single - A single article will display within the Knowledge base assistant on the specified URL
  3. List - A list of selected articles will display under a "Recommended" section within the Knowledge base assistant on the specified URL
  4. 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.

For URL Mapping to work, the Knowledge Base Assistant must be installed within your site or app.

URL Parameters

There are three types of parameters you can include in a Knowledge base assistant URL configuration:

  1. Include Path: /thisis/a/path
  2. Include Query : ?animal=bear
  3. Include Hash: #inbox

You can also include regular expressions in your URL by enabling the Is Regex toggle.


URL Mapping

  1. Go to Settings → Knowledge base assistant → URL mapping

  2. Click New URL mapping on the top right

  3. 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 occur

      Your 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 /ebook/rapid-guide-to-launch-your-knowledge-base/
    • 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

    Category type

    Folder categories are not available for selection. Only page and index category types are available for selection.

  4. Click Create

Now, if an end-user goes to the URL path you specified and opens the Knowledge base assistant, they will see the article/category you've added. 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.

2_Screenshot-KB_assistant_edit_URL_mapping

  1. Go to Settings → Knowledge base assistant → URL mapping
  2. The list of available URL mapping appears
  3. Hover over the desired URL mapping and click the Edit icon

3_Screenshot-KB_assistant_edit_URL_mapping_update

  1. The Update URL mapping blade appears
  2. Update the desired information and click the Update button

Deleting URL mapping

4_Screenshot-KB_assistant_delete_URL_mapping

  1. Go to Settings → Knowledge base assistant → URL mapping
  2. The list of available URL mapping appears
  3. Hover over the desired URL mapping and click the Delete icon

5_Screenshot-KB_assistant_delete_confirmation_URL_mapping

  1. Click Yes in the Delete confirmation prompt

¿Te resultó útil este artículo?

What's Next