Gerenciando e personalizando o widget da base de conhecimento

Widget de base de conhecimento de suporte de planos

Personalizando o widget da base de conhecimento

Você pode personalizar cada widget da base de conhecimento para melhorar a experiência do usuário.

1. Faça login no Knowledge base portal e selecione o projeto desejado.

2. Navegue até o widget da base de conhecimento () na barra de navegação à esquerda. Uma lista de widgets criados será exibida.

3. Passe o mouse sobre o widget desejado e clique no ícone Editar ().

4. Na guia Configurar e conectar , expanda o acordeão do widget Estilo .

5. As seguintes opções de personalização de widget estão disponíveis:

   • Widget color

   • Ícone do widget

   • Posição do widget

   • Ocultar widget

   • Hide most searched articles

Cor do widget

Você pode escolher uma cor de tema para o widget, que também define a cor do ícone.

1. Clique em Alterar cor para abrir a paleta de cores.

2. Selecione uma cor usando o seletor ou insira um código hexadecimal, RGB ou HSL.

Ícone do widget

Da mesma forma, na seção de cores do widget, você pode substituir o ícone por uma imagem ou um ícone disponível.

1. Clique no ícone Alterar.

2. Escolha na guia Conjunto de ícones ou insira uma imagem em Inserir imagem:

   1. Do URL: cole o link da imagem e clique em Inserir.

   2. Do dispositivo: clique em Carregar uma imagem e selecione um arquivo.

3. Clique em Padrão para reverter para o ícone original.

Posição do widget

Controle onde o widget aparece no seu site:

• Escolha Esquerda ou Direita.

• Defina os valores de Espaçamento lateral e Espaçamento inferior para posicionar o widget.

Ocultar widget

Por padrão, a alternância Ocultar widget está desativada, portanto, o widget da base de conhecimento permanece visível no site. Para ocultar o widget, basta ativar a opção Ocultar widget .

Ocultar artigos mais pesquisados

Ative a opção Ocultar artigos mais pesquisados para ocultar a seção de artigos de pesquisa principais.

NOTA

Ativar a alternância Ocultar artigos mais pesquisados desativará a funcionalidade de mapeamento de URL para o widget.

Depois que as alterações forem feitas, clique em Salvar ao lado do campo Nome do widget.

NOTA

A opção de salvamento automático está disponível para navegação entre as guias do widget da base de conhecimento.

Acesso ao conteúdo para o widget da base de conhecimento

Talvez você queira mostrar apenas artigos específicos ou ocultar alguns artigos em seu site da base de conhecimento. Você pode fazer isso de forma eficaz com a opção de acesso ao conteúdo .

Restrição do acesso ao conteúdo em um widget da base de conhecimento

Para restringir o acesso ao conteúdo em um widget da base de conhecimento:

1. Navegue até o widget da base de conhecimento () na barra de navegação à esquerda.

2. Passe o mouse sobre um widget e clique no ícone Editar ().

3. Na guia Configuração e conexão , expanda a seção Acesso ao conteúdo .

4. Você tem três opções:

   1. Projeto

   2. Área de trabalho

   3. Categoria

Projeto

Todos os artigos da base de conhecimento aparecem no Widget. Por padrão, Project é selecionado.

Área de trabalho

Exibir apenas espaços de trabalho ou idiomas específicos:

1. Selecionar área de trabalho > Escolher área de trabalho

2. Marque as caixas de seleção o(s) workspace(s)/idioma(s) desejado(s)

3. Clique em Concluído

4. Clique em Salvar para aplicar as alterações

Por exemplo, você deseja selecionar um espaço de trabalho diferente com um idioma específico.

Categoria

Exibir apenas categorias específicas:

1. Selecione a categoria > Escolha a categoria

2. Selecionar categorias do espaço de trabalho atual ou de outros espaços de trabalho

3. Clique em Concluído

4. Clique em Salvar para aplicar as alterações

Você pode fazer com que as categorias desejadas apareçam no Widget.

Por exemplo, você deseja mostrar apenas as categorias Vendas no Widget.

CUIDADO

As alterações feitas no acesso ao conteúdo afetarão diretamente o mapeamento de URL.

Se você modificar as configurações de filtro do widget, o mapeamento de URL existente poderá ser removido e resultar em links quebrados.

Exemplo 1:
Você definiu o conteúdo do widget de filtro no nível do projeto e configurou um mapeamento de URL que inclui uma lista de artigos da Categoria A no Workspace V1. Se você atualizar as configurações de filtro para mostrar apenas as categorias B e C no mesmo espaço de trabalho, o mapeamento de URL anterior se tornará inválido, pois os artigos originalmente mapeados da categoria A não estão mais disponíveis no widget.

Você só pode configurar mapeamentos de URL usando artigos incluídos no conteúdo atual do widget Filtro.

Exemplo 2:
Se o widget for filtrado para exibir conteúdo somente do Workspace V1, você não poderá criar um mapeamento de URL para um artigo localizado no Workspace V2.

Adicionando links personalizados

Você pode adicionar links personalizados ao widget da base de conhecimento. Os links aparecerão na ordem em que foram criados. Use essa opção para direcionar os usuários finais para páginas ou recursos específicos.

Para adicionar um link personalizado:

1. Navegue até o widget da base de conhecimento () na barra de navegação à esquerda.

2. Passe o mouse sobre o widget desejado e clique no ícone Editar ().

3. Na guia Configurar e conectar, expanda a opção Adicionar links

4. No campo Título da seção , insira o título desejado para essa seção. Isso aparecerá no widget.

5. No título da seção, para cada link, escolha o ícone desejado, o texto do link (que aparecerá no widget) e o link de destino.

   Exemplo:

   • Ícone:

   • Texto do link: Contate-nos

   • Link: support@document360.com

   NOTA

   Você pode usar um mailto: no campo de link. Por exemplo: mailto:<youremail@somedomain.com>

6. Clique em Adicionar e o link será adicionado. Da mesma forma, você pode adicionar vários links.

7. Para editar, clique no ícone Editar (). Clique para salvar e descartar.

8. Clique no ícone Excluir () ao lado dos links para excluí-los.

9. Uma vez feito isso, clique em Salvar para salvar as alterações.

Restrição de domínio

O Document360 permite restringir o widget da base de dados de conhecimento a domínios específicos. Depois que um domínio é adicionado à lista de segurança do widget, qualquer membro do projeto que deseja instalar o widget da base de conhecimento em um domínio diferente deve adicionar esse domínio à seção Segurança do widget .

Se nenhum domínio for adicionado à lista, o widget da base de conhecimento poderá ser incorporado a qualquer aplicativo SaaS ou site público sem restrições.

Restringir o widget da base de conhecimento a um domínio específico

Para restringir o widget da base de conhecimento a um domínio específico,

1. Navegue até o widget da base de conhecimento () na barra de navegação à esquerda.

2. Passe o mouse sobre o widget desejado e clique no ícone Editar ().

3. Na guia Configurar e conectar , expanda a opção Segurança do widget . Você pode encontrar a lista de domínios adicionados anteriormente (se adicionados).

4. Insira o domínio onde você deseja que o widget da base de conhecimento seja exibido.

5. Clique em Adicionar e clique em Salvar.

NOTA

O "www" não é uma parte válida do seu domínio. Adicione apenas o que vem depois do www. em seu URL.

Exemplo: document360.com

Adição de um defletor de ticket no widget da base de conhecimento

Você pode integrar um defletor de tickets para ajudar a desviar consultas de suporte. Para adicionar um defletor de tickets ao widget da base de conhecimento, siga as etapas abaixo:

1. Navegue até o widget da base de conhecimento () na barra de navegação à esquerda.

   A lista de widgets será listada.

2. Passe o mouse sobre o widget desejado e clique no ícone Editar ().

3. Na guia Configurar e conectar , expanda a opção Defletor de tíquetes .

4. Ative a opção Mostrar defletor de ingressos .

5. Selecione o defletor de ticket desejado no menu suspenso.

6. Se necessário, edite o campo Nome do menu .

7. Clique em Salvar.

   O defletor de tickets é adicionado ao widget Base de conhecimento.

Protegendo a autenticação do widget da base de conhecimento usando JWT

Você pode implementar uma configuração de autenticação para o widget usando JWT, garantindo um ambiente seguro para projetos privados e mistos.

1. Navegue até o widget da base de conhecimento () na barra de navegação à esquerda.

   A lista de widgets aparecerá.

2. Passe o mouse sobre o widget desejado e clique no ícone Editar ().

3. Na guia Configurar e conectar , navegue até a opção JWT e ative a opção Ativar JWT.

1. ID do cliente: O ID do cliente será o ID do seu projeto.

2. ID do widget: Como vários widgets podem existir, um ID de widget é fornecido para seus propósitos exclusivos.

3. Ponto de extremidade do token: Um ponto de extremidade de token é um ponto de extremidade HTTP que permite obter um token de acesso com um código de autorização.

4. Segredo do cliente: Clique em Regenerar para gerar o segredo do cliente. Você precisa salvá-lo para fins futuros e o mesmo segredo do cliente será aplicado a todos os widgets no futuro.

NOTA

O segredo do cliente será necessário para widgets JWT que você pode criar. Observe que essas informações não serão armazenadas no Document360.

e. URL de autorização: cole a URL autorizada da página do widget da base de conhecimento.

5. Clique em Salvar.

Incorpore o URL autorizado em seu código e cole-o na seção de script em sua página da web. Isso implementará um widget seguro e autenticado que impede o acesso não autorizado de terceiros.

Implementando o ponto de extremidade de autenticação

[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

Você deve incluir as IDs do grupo de leitores separadas por vírgulas como IDs do grupo de segurança para configurar e renderizar o widget KB.

Solucionando problemas

Esta seção fornece orientação passo a passo para lidar com desafios comuns que você pode encontrar ao gerenciar ou acessar seu widget da base de conhecimento.

O ícone do widget fica visível mesmo após o mapeamento para um botão

Mesmo depois de mapear o widget da base de conhecimento para um botão personalizado, o ícone do widget padrão continua a aparecer no site da base de conhecimento. Isso acontece porque o script do widget inclui a exibição do ícone padrão e não fica oculto automaticamente ao usar um gatilho de botão.

Etapas para resolver:

1. Navegue até o widget da base de conhecimento () na barra de navegação à esquerda.

2. Passe o mouse sobre o widget desejado e clique no ícone Editar ().

3. Expanda a opção Widget Estilo e ative a opção Ocultar widget .

4. Clique em Salvar para aplicar as alterações.

   Atualize seu site da base de conhecimento para ver as alterações.

Uma vez feito isso, o ícone do widget não estará mais visível no site, mas ainda funcionará conforme o esperado quando acionado por meio do botão personalizado.

NOTA

Se você também estiver usando mapeamentos de URL para controlar a visibilidade do widget, consulte Personalização do widget da base de conhecimento usando CSS/JavaScript personalizado para obter opções avançadas de ocultação.