Planes compatibles con el widget de la base de conocimientos
Professional | Business | Enterprise |
---|---|---|
La función de mapeo de URL dentro del widget de la base de conocimientos le permite personalizar la visualización de artículos y categorías específicos en función de las páginas que visitan sus usuarios finales. Esta funcionalidad no solo mejora la experiencia del usuario al dirigirlos a contenido relevante, sino que también le permite ocultar el widget de la base de conocimientos en ciertas URL o proporcionar una barra de búsqueda con marcadores de posición personalizados, guiando a los usuarios sobre qué buscar.
Uso de la asignación de URL
Para configurar la asignación de URL, realice acciones específicas dentro del widget de la base de conocimientos para las URL designadas.
Acciones
Hay cuatro acciones que puedes ejecutar con el mapeo de URL:
Mostrar artículo: Muestra un solo artículo en la dirección URL especificada.
Mostrar lista de artículos: Enumera los artículos seleccionados en la sección Recomendados dentro del widget de la base de conocimientos en la URL especificada.
Mostrar resultados de búsqueda: Le permite establecer un término de búsqueda específico para consultar su base de conocimientos, devolviendo resultados de búsqueda relevantes en la URL especificada.
Ocultar widget: Evita que el icono del widget de la base de conocimientos aparezca en la URL especificada.
Puedes encontrar estas acciones en la pestaña Asignación de URL o al editar una asignación existente.
NOTA
Para que la asignación de URL funcione, el widget de la base de conocimientos debe estar instalado en tu sitio o aplicación. Para obtener más información, lea el artículo sobre Installing the Knowledge base widget.
Parámetros de URL
Al configurar la URL del widget de la base de conocimientos, puede incluir tres tipos de parámetros:
Incluir ruta:
/thisis/a/path
Incluir consulta:
?animal=bear
Incluir hash:
#inbox
También puede habilitar el botón de alternancia Is Regex para incorporar expresiones regulares en las configuraciones de URL.
Agregar mapeo de URL a su widget
Para integrar el widget deseado en el sitio de la base de conocimientos, siga estos pasos:
Vaya a la pestaña Mapeo de URL en el Widget () en el Knowledge base portal.
Haga clic en Nueva asignación de URL y especifique lo siguiente:
Nombre : el nombre de la asignación de URL solo se mostrará en el registro de asignación de URL dentro de Document360
Estructura de URL : seleccione el tipo de parámetro de URL deseado (Incluir ruta/Incluir consulta/Incluir hash). Debe habilitar al menos un parámetro de URL
Escriba la URL en la que desea que se muestre el artículo/categoría o que se realice la acción.
NOTA
Su nombre de dominio no está incluido en la ruta de la URL. Por ejemplo,
https://document360.com/ebook/rapid-guide-to-launch-your-knowledge-base/
, la ruta de su URL sería/ebook/rapid-guide-to-launch-your-knowledge-base/
Acción : seleccione la acción deseada.
Seleccionar espacio de trabajo : seleccione la versión deseada (si tiene varias versiones).
Idioma a : seleccione el idioma deseado (si tiene varios idiomas).
Artículo para mostrar : en la barra de búsqueda, seleccione los artículos o categorías que desea mostrar en la documentación de la base de conocimientos.
NOTA
Las categorías de carpetas no están disponibles para su selección. Solo los tipos de categoría de página e índice están disponibles para su selección.
Haga clic en Crear.
Una vez que un usuario final acceda a la ruta URL especificada y abra el widget de la base de conocimientos, verá el artículo/categoría asignado. Esta información permanece coherente a medida que navegan entre las pestañas del widget de la base de conocimientos dentro de la misma versión e idioma.
Edición de la asignación de URL
Para modificar una asignación de URL existente:
Vaya a Widget () en el Knowledge base portal.
Coloque el cursor sobre el widget de la base de conocimientos deseado y haga clic en el icono Editar ().
En la pestaña Asignación de URL , puede encontrar la lista de asignaciones de URL disponibles.
Coloque el cursor sobre la asignación de URL deseada y haga clic en el icono Editar ().
Aparecerá la hoja Actualizar asignación de URL .
Actualice la información deseada y haga clic en Actualizar.
Eliminación de la asignación de URL
Puede eliminar una asignación de URL establecida.
Vaya a Widget () en el Knowledge base portal.
Coloque el cursor sobre el widget de la base de conocimientos deseado y haga clic en el icono Editar ().
En la pestaña Asignación de URL , puede encontrar la lista de asignaciones de URL disponibles.
Coloque el cursor sobre la asignación de URL deseada y haga clic en el icono Eliminar ().
Haga clic en Sí en el mensaje de confirmación Eliminar .
Configuración de mapeo de URL
Puede definir el comportamiento del widget de la base de conocimientos para las URL que no tienen una asignación configurada. Definir este comportamiento puede mejorar la experiencia del usuario y la accesibilidad a la documentación.
Vaya a Widget () en el Knowledge base portal > Configurar y conectar.
En la sección Establecer controles , expanda la sección Configuración de asignación de URL .
Seleccione la opción deseada:
Navegar a la página de ayuda/base de conocimientos: seleccione esta opción para mostrar el artículo/categoría en la página de ayuda o en la pestaña Base de conocimientos en el widget.
No realizar ningún cambio en la configuración existente: Seleccione esta opción para mostrar el último artículo/categoría abierto en el widget.
Haga clic en Guardar.
Coincidencia básica de URL
Comprender la coincidencia de URL es crucial para un mapeo de URL efectivo. Una expresión regular de uso general para hacer coincidir las URL típicas tiene el siguiente aspecto:
^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$
Explicación de los componentes
^https?://?
: Coincide con el protocolo (por ejemplo,http://
ohttps://
). Esto?
hace que el protocolo sea opcional.NOTA
Asegúrese de agregar una barra diagonal inversa (\) antes de cada barra diagonal (/) mientras prueba su URL en https://regex101.com.
[a-zA-Z0-9.-]+
: Coincide con el nombre de dominio, incluidas letras, números, puntos (.
) y guiones (-
)./[a-zA-Z0-9/._-]*?
: Coincide con la ruta después del dominio, lo que permite barras diagonales, caracteres alfanuméricos, puntos, guiones bajos y guiones.?[a-zA-Z0-9=&._-]*?
: Coincide con los parámetros de consulta opcionales (por ejemplo,?key=value
), lo que hace que esta parte sea opcional.#[a-zA-Z0-9_-]*?
: Coincide con el fragmento (por ejemplo,#section
), que también es opcional.
Ejemplos de mapeo de URL con Regex
Mapeo de URL con rutas específicas
Para asignar un patrón de URL como /users/{id}
, use:
^/users/[0-9]+$
Esto captura un ID de usuario de forma dinámica.
Ejemplos de coincidencias
/users/123
/users/456
Asignación de direcciones URL con parámetros de consulta
Para URL como /search?q={query}
, la expresión regular sería:
^/search?q=[a-zA-Z0-9]+$
Ejemplos de coincidencias
/search?q=apple
/search?q=123abc
Asignación de URL con parámetros opcionales
Para un patrón de URL como /products/{category}/{id}
, donde category es opcional:
^/products/[a-zA-Z]+?/[0-9]+$
Ejemplos de coincidencias
/products/123
/products/electronics/123
Asignación de direcciones URL con comodines o varias rutas
Para /blog/*
:
^/blog/.*?$
Ejemplos de coincidencias
/blog
/blog/how-to-code
/blog/2021/10
Mapeo de URL con subdominios
En el caso de las URL de subdominio:
^https?://?[a-zA-Z0-9-]+.example.com$
Ejemplos de coincidencias
http://blog.example.com
https://shop.example.com
Combinación de múltiples componentes
Para manejar asignaciones de URL más complejas, puede combinar los distintos componentes según sea necesario. La expresión regular completa que coincide con una dirección URL con un protocolo, dominio, ruta de acceso, parámetros de consulta y fragmento opcionales tiene el siguiente aspecto:
^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$
Preguntas frecuentes
¿Cómo puedo eliminar la ayuda de la página y la barra de búsqueda del widget cuando se configura la asignación de URL para un solo artículo?
Para eliminar la ayuda de la página y la barra de búsqueda del widget cuando se configura la asignación de URL para un solo artículo:
Vaya a Widget () en el portal de la base de conocimientos.
Coloque el cursor sobre el widget deseado y haga clic en el icono Editar ().
Pegue el código proporcionado en la pestaña CSS personalizado :
li#page-help-tab { display: none; } .article-header .article-back-icon { display: none; } .search-container { display: none !Important; }
Pegue el código proporcionado en la pestaña JavaScript personalizado :
setTimeout(function() { $('.search-container').hide();}, 2000); setTimeout(function() { $("#knowledge-base-tab").click();}, 2000);
Haga clic en Guardar.
Esto ocultará la pestaña de ayuda de la página y la barra de búsqueda en el widget del sitio de la base de conocimientos cuando se configure la asignación de URL para un solo artículo.
¿Cómo puedo ver las actualizaciones inmediatamente en el widget de KB después de agregar o actualizar un mapa de URL?
Las actualizaciones se almacenan en caché en el servidor por motivos de rendimiento y se actualizarán automáticamente cada 15 minutos. Sin embargo, si necesita ver los cambios de inmediato, puede borrar el caché de la aplicación.