Gestion et personnalisation du widget Base de connaissances

Plans prenant en charge le widget de base de connaissances

Personnalisation du widget de la base de connaissances

Vous pouvez personnaliser chaque widget de la base de connaissances pour améliorer l’expérience utilisateur.

1. Connectez-vous à la Knowledge base portal et sélectionnez le projet de votre choix.

2. Accédez au widget Base de connaissances () dans la barre de navigation de gauche. Une liste des widgets créés s’affiche.

3. Passez la souris sur le widget souhaité et cliquez sur l’icône Modifier ().

4. Dans l’onglet Configurer et connecter , développez le widget Style accordéon.

5. Les options de personnalisation des widgets suivantes sont disponibles :

   • Widget color

   • Icône du widget

   • Position du widget

   • Masquer le widget

   • Hide most searched articles

Couleur du widget

Vous pouvez choisir une couleur de thème pour le widget, qui définit également la couleur de l’icône.

1. Cliquez sur Modifier la couleur pour ouvrir la palette de couleurs.

2. Sélectionnez une couleur à l’aide du sélecteur ou entrez un code hexadécimal, RVB ou HSL.

Icône du widget

De même, dans la section couleur du widget, vous pouvez remplacer l’icône par une image ou une icône disponible.

1. Cliquez sur l’icône Modifier.

2. Choisissez dans l’onglet Jeu d’icônes ou insérez une image sous Insérer une image :

   1. À partir de l’URL : collez le lien de l’image et cliquez sur Insérer.

   2. À partir de l’appareil : cliquez sur Télécharger une image et sélectionnez un fichier.

3. Cliquez sur Par défaut pour revenir à l’icône d’origine.

Position du widget

Contrôlez l’emplacement d’affichage du widget sur votre site :

• Choisissez Gauche ou Droite.

• Définissez les valeurs Espacement latéral et Espacement inférieur pour positionner le widget.

Masquer le widget

Par défaut, l’option Masquer le widget est désactivée, de sorte que le widget Base de connaissances reste visible sur le site. Pour masquer le widget, il suffit d’activer la bascule Masquer le widget .

Masquer les articles les plus recherchés

Activez l’option Masquer les articles les plus recherchés pour masquer la section des articles les plus recherchés.

NOTE

L’activation de l’option Masquer les articles les plus recherchés désactivera la fonctionnalité de mappage d’URL pour le widget.

Une fois vos modifications effectuées, cliquez sur Enregistrer à côté du champ Nom du widget.

NOTE

L’option d’enregistrement automatique permet de naviguer entre les onglets du widget Base de connaissances.

Accès au contenu du widget Base de connaissances

Vous pouvez afficher uniquement des articles particuliers ou masquer certains articles dans votre site de base de connaissances. Vous pouvez le faire efficacement avec l’option d’accès au contenu .

Restriction de l’accès au contenu d’un widget de la base de connaissances

Pour restreindre l’accès au contenu d’un widget de la base de connaissances :

1. Accédez au widget Base de connaissances () dans la barre de navigation de gauche.

2. Passez la souris sur un widget et cliquez sur l’icône Modifier ().

3. Dans l’onglet Configuration et connexion , développez la section Accès au contenu .

4. Trois options s’offrent à vous :

   1. Projet

   2. Espace

   3. Catégorie

Projet

Tous les articles de la base de connaissances apparaissent dans le widget. Par défaut, l’option Projet est sélectionnée.

Espace

N’affichez que des espaces de travail ou des langues spécifiques :

1. Sélectionner > Espace de travail Choisir un espace de travail

2. Cochez les cases de l’espace de travail/langue(s) souhaité(s)

3. Cliquez sur Terminé

4. Cliquez sur Enregistrer pour appliquer les modifications

Par exemple, vous souhaitez sélectionner un autre espace de travail avec une langue spécifique.

Catégorie

Afficher uniquement les catégories spécifiques :

1. Sélectionner une catégorie > Choisir une catégorie

2. Sélectionner des catégories dans l’espace de travail actuel ou dans d’autres espaces de travail

3. Cliquez sur Terminé

4. Cliquez sur Enregistrer pour appliquer les modifications

Vous pouvez faire apparaître les catégories souhaitées dans le widget.

Par exemple, vous souhaitez afficher uniquement les catégories de ventes dans le widget.

PRUDENCE

Les modifications apportées à l’accès au contenu auront un impact direct sur votre mappage d’URL.

Si vous modifiez les paramètres de filtrage du widget, le mappage d’URL existant peut être supprimé et entraîner des liens rompus.

Exemple 1 :
Vous avez défini le contenu du widget de filtre au niveau du projet et configuré un mappage d’URL qui inclut une liste d’articles de la catégorie A dans Workspace V1. Si vous mettez à jour les paramètres de filtre pour afficher uniquement les catégories B et C dans le même espace de travail, le mappage d’URL précédent n’est plus valide, car les articles initialement mappés de la catégorie A ne sont plus disponibles dans le widget.

Vous ne pouvez configurer les mappages d’URL qu’à l’aide d’articles inclus dans le contenu actuel du widget Filtre.

Exemple 2 :
Si le widget est filtré pour afficher uniquement le contenu de Workspace V1, vous ne pouvez pas créer de mappage d’URL pour un article situé dans Workspace V2.

Ajouter des liens personnalisés

Vous pouvez ajouter des liens personnalisés au widget Base de connaissances. Les liens apparaîtront dans l’ordre dans lequel ils ont été créés. Utilisez cette option pour diriger les utilisateurs finaux vers des pages ou des ressources spécifiques.

Pour ajouter un lien personnalisé :

1. Accédez au widget Base de connaissances () dans la barre de navigation de gauche.

2. Passez la souris sur le widget souhaité et cliquez sur l’icône Modifier ().

3. Dans l’onglet Configurer et connecter, développez l’accordéon Ajouter des liens

4. Dans le champ Titre de la section , entrez le titre souhaité pour cette section. Cela apparaîtra dans le widget.

5. Sous le titre de la section, pour chaque lien, choisissez l’icône souhaitée, le texte du lien (qui apparaîtra dans le widget) et le lien de destination.

   Exemple:

   • Icône :

   • Texte du lien : Contactez-nous

   • Lien: support@document360.com

   NOTE

   Vous pouvez utiliser un dans le champ de mailto: lien. Par exemple : mailto :<youremail@somedomain.com>

6. Cliquez sur Ajouter et le lien sera ajouté. De même, vous pouvez ajouter plusieurs liens.

7. Pour modifier, cliquez sur l’icône Modifier (). Cliquez pour enregistrer et pour jeter.

8. Cliquez sur l’icône Supprimer () en regard des liens pour les supprimer.

9. Une fois cela fait, cliquez sur Enregistrer pour enregistrer les modifications.

Restriction de domaine

Document360 vous permet de restreindre le widget Base de connaissances à des domaines spécifiques. Une fois qu’un domaine est ajouté à la liste de sécurité du widget, tout membre du projet qui souhaite installer le widget de la base de connaissances sur un autre domaine doit ajouter ce domaine à la section Sécurité du widget .

Si aucun domaine n’est ajouté à la liste, le widget Base de connaissances peut être intégré dans n’importe quelle application SaaS ou site Web public sans restriction.

Limiter le widget Base de connaissances à un domaine spécifique

Pour restreindre votre widget de base de connaissances à un domaine spécifique,

1. Accédez au widget Base de connaissances () dans la barre de navigation de gauche.

2. Passez la souris sur le widget souhaité et cliquez sur l’icône Modifier ().

3. Dans l’onglet Configurer et connecter , développez l’accordéon de sécurité Widget . Vous pouvez trouver la liste des domaines précédemment ajoutés (le cas échéant).

4. Entrez le domaine dans lequel vous souhaitez afficher le widget Base de connaissances.

5. Cliquez sur Ajouter , puis sur Enregistrer.

NOTE

Le « www » n’est pas une partie valide de votre domaine. N’ajoutez que ce qui vient après le www. dans votre URL.

Exemple : document360.com

Ajout d’un déflecteur de tickets dans le widget de la base de connaissances

Vous pouvez intégrer un déflecteur de tickets pour aider à dévier les requêtes d’assistance. Pour ajouter un déflecteur de tickets à votre widget de base de connaissances, procédez comme suit :

1. Accédez au widget Base de connaissances () dans la barre de navigation de gauche.

   La liste des widgets sera répertoriée.

2. Passez la souris sur le widget souhaité et cliquez sur l’icône Modifier ().

3. Dans l’onglet Configurer et connecter , développez l’accordéon Déflecteur de billets .

4. Activez le bouton Déflecteur de billets de spectacle .

5. Sélectionnez le déflecteur de billets souhaité dans la liste déroulante.

6. Si nécessaire, modifiez le champ Nom du menu .

7. Cliquez sur Enregistrer.

   Le déflecteur de billets est ajouté au widget de la base de connaissances.

Sécurisation de l’authentification du widget de la base de connaissances à l’aide de JWT

Vous pouvez implémenter une configuration d’authentification pour le widget à l’aide de JWT, garantissant ainsi un environnement sécurisé pour les projets privés et mixtes.

1. Accédez au widget Base de connaissances () dans la barre de navigation de gauche.

   La liste des widgets apparaîtra.

2. Passez la souris sur le widget souhaité et cliquez sur l’icône Modifier ().

3. Dans l’onglet Configurer et connecter , accédez à l’accordéon JWT et activez le bouton bascule JWT Enable .

1. ID du client : L’ID client sera l’ID de votre projet.

2. ID du widget : Étant donné qu’il peut exister plusieurs widgets, un ID de widget est fourni à des fins uniques.

3. Point de terminaison du jeton : Un point de terminaison de jeton est un point de terminaison HTTP qui vous permet d’obtenir un jeton d’accès à partir d’un code d’autorisation.

4. Clé secrète client : Cliquez sur Régénérer pour générer la clé secrète client. Vous devez l’enregistrer à des fins ultérieures et la même clé secrète client s’appliquera à tous les widgets à l’avenir.

NOTE

La clé secrète client sera requise pour les widgets JWT que vous pouvez créer. Notez que ces informations ne seront pas stockées dans Document360.

e. Autoriser l’URL : collez l’URL autorisée à partir de la page Web de votre widget de base de connaissances.

5. Cliquez sur Enregistrer.

Intégrez l’URL autorisée dans votre code et collez-la dans la section script de votre page Web. Cela mettra en œuvre un widget sécurisé et authentifié qui empêche l’accès non autorisé de tiers.

Implémentation du point de terminaison d’authentification

[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 });
    }
}

NOTE

Vous devez inclure les ID de groupe de lecteurs séparés par des virgules en tant qu’ID de groupe de sécurité pour configurer et afficher le widget KB.

Dépannage

Cette section fournit des instructions étape par étape pour résoudre les problèmes courants que vous pouvez rencontrer lors de la gestion ou de l’accès à votre widget de base de connaissances.

L’icône du widget est visible même après le mappage sur un bouton

Même après avoir mappé le widget de la base de connaissances à un bouton personnalisé, l’icône du widget par défaut continue d’apparaître sur le site de la base de connaissances. Cela se produit parce que le script du widget inclut l’affichage de l’icône par défaut et qu’il n’est pas automatiquement masqué lors de l’utilisation d’un déclencheur de bouton.

Étapes à résoudre :

1. Accédez au widget Base de connaissances () dans la barre de navigation de gauche.

2. Passez la souris sur le widget souhaité et cliquez sur l’icône Modifier ().

3. Développez l’accordéon du widget Style et activez l’option Masquer le widget .

4. Cliquez sur Enregistrer pour appliquer les modifications.

   Actualisez votre site de base de connaissances pour voir les modifications.

Une fois cela fait, l’icône du widget ne sera plus visible sur le site, mais elle fonctionnera toujours comme prévu lorsqu’elle sera déclenchée via votre bouton personnalisé.

NOTE

Si vous utilisez également des mappages d’URL pour contrôler la visibilité du widget, reportez-vous à la section Personnalisation du widget de la base de connaissances à l’aide de CSS/JavaScript personnalisé pour connaître les options de masquage avancées.