Administrar y personalizar el widget de la base de conocimientos

Planes compatibles con el widget de la base de conocimientos

Personalización del widget de la base de conocimientos

Puede personalizar cada widget de la base de conocimientos para mejorar la experiencia del usuario.

1. Inicie sesión en el Knowledge base portal y seleccione el proyecto que desee.

2. Vaya al widget de la base de conocimientos () en la barra de navegación izquierda. Se mostrará una lista de los widgets creados.

3. Coloque el cursor sobre el widget deseado y haga clic en el icono Editar ().

4. En la pestaña Configurar y conectar , expanda el acordeón del widget Estilo .

5. Están disponibles las siguientes opciones de personalización de widgets:

   • Widget color

   • Icono de widget

   • Posición del widget

   • Ocultar widget

   • Hide most searched articles

Color del widget

Puede elegir un color de tema para el widget, que también establece el color del icono.

1. Haga clic en Cambiar color para abrir la paleta de colores.

2. Seleccione un color con el selector o introduzca un código hexadecimal, RGB o HSL.

Icono de widget

Del mismo modo, en la sección de color del widget, puede reemplazar el icono por una imagen o un icono disponible.

1. Haga clic en el icono Cambiar.

2. Elija en la pestaña Conjunto de iconos o inserte una imagen en Insertar imagen:

   1. Desde URL: Pega el enlace de la imagen y haz clic en Insertar.

   2. Desde el dispositivo: haz clic en Subir una imagen y selecciona un archivo.

3. Haga clic en Predeterminado para volver al icono original.

Posición del widget

Controla dónde aparece el widget en tu sitio:

• Elija Izquierda o Derecha.

• Establezca los valores de Espaciado lateral y Espaciado inferior para colocar el widget.

Ocultar widget

De forma predeterminada, el botón de alternancia Ocultar widget está desactivado, por lo que el widget de la base de conocimientos permanece visible en el sitio. Para ocultar el widget, simplemente habilite la opción Ocultar widget .

Ocultar los artículos más buscados

Activa la opción Ocultar los artículos más buscados para ocultar la sección de artículos de búsqueda principales.

NOTA

Al habilitar la opción Ocultar artículos más buscados , se deshabilitará la funcionalidad de mapeo de URL para el widget.

Una vez realizados los cambios, haga clic en Guardar junto al campo Nombre del widget.

NOTA

La opción de guardado automático está disponible para la navegación entre las pestañas del widget de la base de conocimientos.

Acceso al contenido del widget de la base de conocimientos

Es posible que desee mostrar solo artículos concretos u ocultar algunos artículos en el sitio de la base de conocimientos. Puede hacerlo de manera efectiva con la opción Acceso al contenido .

Restringir el acceso al contenido en un widget de la base de conocimientos

Para restringir el acceso al contenido en un widget de la base de conocimientos:

1. Vaya al widget de la base de conocimientos () en la barra de navegación izquierda.

2. Coloque el cursor sobre un widget y haga clic en el icono Editar ().

3. En la pestaña Configuración y conexión , expanda la sección Acceso al contenido .

4. Tienes tres opciones:

   1. Proyecto

   2. Área de trabajo

   3. Categoría

Proyecto

Todos los artículos de la base de conocimientos aparecen en el widget. De forma predeterminada, se selecciona Proyecto .

Área de trabajo

Mostrar solo espacios de trabajo o idiomas específicos:

1. Seleccione Workspace > Elija workspace

2. Seleccione las casillas de verificación del espacio de trabajo/idioma (s) deseado

3. Haga clic en Listo

4. Haga clic en Guardar para aplicar los cambios

Por ejemplo, desea seleccionar un área de trabajo diferente con un idioma específico.

Categoría

Mostrar solo categorías específicas:

1. Seleccionar categoría > Elegir categoría

2. Seleccionar categorías del espacio de trabajo actual o de otros espacios de trabajo

3. Haga clic en Listo

4. Haga clic en Guardar para aplicar los cambios

Puede hacer que las categorías deseadas aparezcan en el widget.

Por ejemplo, desea mostrar solo las categorías de ventas en el widget.

CAUTELA

Los cambios realizados en el acceso al contenido afectarán directamente a la asignación de URL.

Si modifica la configuración del filtro del widget, es posible que se elimine la asignación de URL existente y que se produzcan enlaces rotos.

Ejemplo 1:
Ha establecido el contenido del widget de filtro en el nivel de proyecto y ha configurado una asignación de URL que incluye una lista de artículos de la categoría A en Workspace V1. Si actualiza la configuración del filtro para mostrar solo las categorías B y C en el mismo espacio de trabajo, la asignación de URL anterior deja de ser válida, ya que los artículos asignados originalmente de la categoría A ya no están disponibles en el widget.

Solo puede configurar asignaciones de URL mediante artículos incluidos en el contenido actual del widget Filtro.

Ejemplo 2:
Si el widget se filtra para mostrar contenido solo desde Workspace V1, no puede crear una asignación de URL para un artículo ubicado en Workspace V2.

Adición de enlaces personalizados

Puede agregar enlaces personalizados al widget de la base de conocimientos. Los enlaces aparecerán en el orden en que se crearon. Utilice esta opción para dirigir a los usuarios finales a páginas o recursos específicos.

Para agregar un enlace personalizado:

1. Vaya al widget de la base de conocimientos () en la barra de navegación izquierda.

2. Coloque el cursor sobre el widget deseado y haga clic en el icono Editar ().

3. En la pestaña Configurar y conectar, expanda el acordeón Agregar vínculos

4. En el campo Título de la sección , introduzca el título deseado para esa sección. Esto aparecerá en el widget.

5. En el título de la sección, para cada enlace, elija el icono deseado, el texto del enlace (que aparecerá en el widget) y el enlace de destino.

   Ejemplo:

   • Icono:

   • Texto del enlace: Contáctenos

   • Enlace: support@document360.com

   NOTA

   Puede usar un mailto: en el campo de enlace. Por ejemplo: mailto:<youremail@somedomain.com>

6. Haga clic en Agregar y se agregará el enlace. Del mismo modo, puede agregar varios enlaces.

7. Para editar, haga clic en el icono Editar (). Haga clic para guardar y descartar.

8. Haga clic en el icono Eliminar () junto a los enlaces para eliminarlos.

9. Una vez hecho esto, haga clic en Guardar para guardar los cambios.

Restricción de dominio

Document360 permite restringir el widget de la base de conocimientos a dominios específicos. Una vez que se agrega un dominio a la lista de seguridad del widget, cualquier miembro del proyecto que desee instalar el widget de la base de conocimientos en un dominio diferente debe agregar ese dominio a la sección de seguridad del widget .

Si no se agrega ningún dominio a la lista, el widget de la base de conocimientos se puede incrustar en cualquier aplicación SaaS o sitio web público sin restricciones.

Restringir el widget de la base de conocimientos a un dominio específico

Para restringir el widget de la base de conocimientos a un dominio específico,

1. Vaya al widget de la base de conocimientos () en la barra de navegación izquierda.

2. Coloque el cursor sobre el widget deseado y haga clic en el icono Editar ().

3. En la pestaña Configurar y conectar , expanda el acordeón de seguridad del widget . Puede encontrar la lista de dominios agregados anteriormente (si se agregaron).

4. Introduzca el dominio en el que desea que se muestre el widget de la base de conocimientos.

5. Haga clic en Agregar y haga clic en Guardar.

NOTA

El "www" no es una parte válida de su dominio. Solo agregue lo que viene después de www. en tu URL.

Ejemplo: document360.com

Agregar un deflector de tickets en el widget de la base de conocimientos

Puede integrar un deflector de tickets para ayudar a desviar las consultas de soporte. Para agregar un deflector de tickets a su widget de la base de conocimientos, siga los pasos a continuación:

1. Vaya al widget de la base de conocimientos () en la barra de navegación izquierda.

   Se mostrará la lista de widgets.

2. Coloque el cursor sobre el widget deseado y haga clic en el icono Editar ().

3. En la pestaña Configurar y conectar , expanda el acordeón del deflector de tickets .

4. Activa el botón de alternancia Mostrar deflector de ticket .

5. Seleccione el deflector de tickets deseado en el menú desplegable.

6. Si es necesario, edite el campo Nombre del menú .

7. Haga clic en Guardar.

   El deflector de tickets se agrega al widget de la base de conocimientos.

Protección de la autenticación de widgets de la base de conocimientos mediante JWT

Puede implementar una configuración de autenticación para el widget mediante JWT, lo que garantiza un entorno seguro para proyectos privados y mixtos.

1. Vaya al widget de la base de conocimientos () en la barra de navegación izquierda.

   Aparecerá la lista de widgets.

2. Coloque el cursor sobre el widget deseado y haga clic en el icono Editar ().

3. En la pestaña Configurar y conectar , navegue hasta el acordeón JWT y active la opción Habilitar JWT.

1. ID de cliente: El ID de cliente será el ID de tu proyecto.

2. ID del widget: Dado que pueden existir varios widgets, se proporciona un ID de widget para sus fines únicos.

3. Punto de conexión del token: Un punto de conexión de token es un punto de conexión HTTP que le permite obtener un token de acceso dado un código de autorización.

4. Secreto de cliente: Haga clic en Regenerar para generar el secreto de cliente. Debe guardar esto para fines futuros y el mismo secreto de cliente se aplicará a todos los widgets en el futuro.

NOTA

El secreto de cliente será necesario para los widgets JWT que pueda crear. Tenga en cuenta que esta información no se almacenará en Document360.

e. Autorizar URL: Pegue la URL autorizada de la página web del widget de la base de conocimientos.

5. Haga clic en Guardar.

Inserta la URL autorizada en el código y pégala en la sección de scripts de la página web. Esto implementará un widget seguro y autenticado que evita el acceso no autorizado de terceros.

Implementación del punto de conexión de autenticación

[HttpGet]
[Route("authenticate")]
public async Task<IActionResult> WidgetAuthentication(string id)
{
    if (HttpContext.User.Identity.IsAuthenticated)
    {
        var clientData = new ClientDetails()
        {
            ClientId = "{Client ID}",
            Secret = "{Client secret}",
            TokenEndpoint = "{Token endpoint}",
            WidgetId = "{Widget ID}",
            SecurityGroupIds = "{Comma separated reader group IDs}", // mandatory for configuration to render KB widget
            TokenValidity = 15, // integer representing token validity in minutes
        };

        if (clientData == null)
            return NotFound();

        List<string> readerGroupids = null;
        if (!string.IsNullOrEmpty(clientData.SecurityGroupIds))
            readerGroupids = clientData.SecurityGroupIds.Split(',').Select(c => c.Trim()).ToList();

        var payload = new
        {
            username = "{Username}",
            firstName = "{First name}",
            lastName = "{Last name}",
            emailId = "{Email address}",
            readerGroupIds = readerGroupids,
            tokenValidity = clientData.TokenValidity,
            widgetId = clientData.WidgetId,
            projectId = clientData.ClientId
        };

        var payloadString = JsonConvert.SerializeObject(payload);

        var result = await client.RequestTokenAsync(new TokenRequest
        {
            Address = clientData.TokenEndpoint,
            ClientId = clientData.ClientId,
            ClientSecret = clientData.Secret,
            GrantType = "Widget",
            Parameters =
            {
                {
                    "payload",  payloadString
                },
                {
                    "id", clientData.ClientId
                },
            }
        });

        return Ok(new
        {
            accessToken = result.AccessToken,
            expiresIn = result.ExpiresIn
        });
    }
    else
    {
        return Unauthorized(new { success = false });
    }
}

NOTA

Debe incluir los ID de grupo de lectores separados por comas como ID de grupo de seguridad para configurar y representar el widget de KB.

Solución de problemas

En esta sección se proporciona una guía paso a paso para abordar los desafíos comunes que puede encontrar al administrar o acceder a su widget de base de conocimientos.

El icono del widget es visible incluso después de asignarlo a un botón

Incluso después de asignar el widget de la base de conocimientos a un botón personalizado, el icono del widget predeterminado sigue apareciendo en el sitio de la base de conocimientos. Esto sucede porque el script del widget incluye la visualización de iconos predeterminada y no se oculta automáticamente cuando se usa un activador de botón.

Pasos para resolverlo:

1. Vaya al widget de la base de conocimientos () en la barra de navegación izquierda.

2. Coloque el cursor sobre el widget deseado y haga clic en el icono Editar ().

3. Expanda el acordeón del widget Estilo y active el botón de alternancia Ocultar widget .

4. Haga clic en Guardar para aplicar los cambios.

   Actualice el sitio de la base de conocimientos para ver los cambios.

Una vez hecho esto, el icono del widget ya no será visible en el sitio, pero seguirá funcionando como se espera cuando se active a través de su botón personalizado.

NOTA

Si también utiliza asignaciones de URL para controlar la visibilidad de los widgets, consulte Personalización del widget de la base de conocimientos mediante CSS/JavaScript personalizado para conocer las opciones de ocultación avanzadas.