Cet article fournit un aperçu du processus de migration du contenu existant vers votre la base de connaissances et la communauté de votre nouveau Centre d’aide.
Sujets couverts :
Migration du contenu vers la base de connaissances
La migration du contenu à partir d’un système externe vers le Centre d’aide est un processus à plusieurs étapes, dans lequel les données d’une étape sont nécessaires aux étapes suivantes.
La planification est essentielle. Vous devrez mapper la structure de votre ancien contenu avec la structure en 3 parties du Centre d’aide :
Importation de vos auteurs en tant qu’utilisateurs Zendesk
Commencez par importer les auteurs de vos articles en tant qu’utilisateurs Zendesk. Dans le Centre d’aide, les auteurs des articles doivent être des utilisateurs Zendesk avec le rôle d’agent. Un agent dans Zendesk n’est pas obligatoirement une personne qui résout des tickets. Consultez Rôles des utilisateurs Zendesk Support.
Pour créer des utilisateurs Zendesk avec l’API, consultez la section sur la création d’utilisateurs dans la documentation de l’API Zendesk. Pensez à définir l’attribut role sur « agent » dans chaque requête POST.
Une fois que vous avez créé un utilisateur, Zendesk renvoie les détails de l’utilisateur dans la réponse JSON, notamment le nouvel ID de l’utilisateur :
{
"user": {
"id": 9873843,
"name": "Roger Wilco",
...
}
}
Notez l’ID de chaque utilisateur. Vous en aurez besoin pour définir l’attribut author_id de chaque article que vous créez dans le Centre d’aide.
Conseil : il peut être judicieux de créer un mappage pour chaque ID d’auteur et ses anciens articles.
Si vous projetez d’utiliser les organisations dans les segments d’utilisateurs pour séparer les sections, les organisations doivent être créées avant les utilisateurs. Quand vous créerez un utilisateur, vous pourrez lui affecter l’ID de l’organisation. Consultez Création d’organisations dans la documentation destinée aux développeurs. Si les utilisateurs doivent appartenir à plusieurs organisations, utilisez les appartenances aux organisations pour ajouter des organisations aux enregistrements des utilisateurs.
Création de catégories dans la base de connaissances
Consultez la section sur la création de catégories dans la documentation de l’API du Centre d’aide. Les catégories sont des groupes de sections.
Après la création d’une catégorie, Zendesk renvoie une réponse JSON avec le nouvel ID de la catégorie :
{
"category": {
"id": 37486578,
"name": "Super Hero Tricks",
"description": "This category contains a collection of Super Hero tricks",
"locale": "en-us",
"position": 2,
...
}
}
Notez l’ID de chaque catégorie. Vous en aurez besoin quand vous créerez des sections, pour affecter les sections à des catégories spécifiques.
Création de segments d’utilisateurs (facultatif)
Si vous voulez restreindre l’accès à certaines sections du Centre d’aide, vous pouvez leur affecter des segments d’utilisateurs. Consultez la section sur la création de segments d’utilisateurs dans la documentation de l’API du Centre d’aide.
Après la création d’un segment d’utilisateurs, Zendesk renvoie une réponse JSON avec le nouvel ID du segment d’utilisateurs :
{
"user_segment": {
"id": 7284
"name": "VIP agents",
"user_type": "staff",
"group_ids": [12, ...],
"organization_ids": [42, ...],
"tags": ["vip"],
"created_at": "2017-05-21T20:01:12Z",
"updated_at": "2017-05-21T20:01:12Z",
"built_in": false
}
}
Notez l’ID de chaque segment d’utilisateurs. Vous en aurez besoin quand vous créerez des sections, pour affecter les restrictions d’accès aux sections.
Création de sections au sein des catégories
Consultez la section sur la création de sections dans la documentation de l’API du Centre d’aide. Les sections sont des groupes d’articles.
N’oubliez pas de définir category_id et user_segment_id (le cas échéant) dans chaque requête POST. Zendesk renvoie une réponse JSON avec le nouvel ID de la section :
{
"section": {
"id": 3457836,
"name": "Avionics",
"description": "This section contains articles on flight instruments",
"locale": "en-us",
"category_id": 3465,
...
}
}
Notez l’ID de chaque section. Vous en aurez besoin quand vous créerez des articles, pour affecter les articles à des sections spécifiques.
Création des articles au sein des sections
Une fois que vous avez tous les ID de section et d’utilisateur, vous pouvez créer les articles. Consultez la section sur la création d’articles dans la documentation de l’API du Centre d’aide. En plus de title et body, n’oubliez pas de définir author_id et section_id dans chaque requête POST.
Remarque - Tous les auteurs sont automatiquement abonnés à leurs articles. Si le Centre d’aide est activé, ils reçoivent une notification par e-mal à la création de l’article.
Zendesk renvoie une réponse JSON ressemblant à ce qui suit :
{
"article": {
"id": 37486578,
"author_id": 3465,
"promoted": false,
"position": 42,
"comments_disabled": true,
"section_id": 98838,
...
}
}
Téléchargement de pièces jointes (si nécessaire)
Si un article contient des images incorporées qui ne sont pas hébergées sur un serveur de fichiers public comme Amazon S3, téléchargez les images dans le Centre d’aide. Consultez la section sur la création de pièces jointes non associées dans la documentation destinée aux développeurs. N’oubliez pas de définir le paramètre inline sur true.
Zendesk renvoie une réponse JSON avec une URL (content_url) pour la pièce jointe :
{
"article_attachment": {
"id": 1428,
"article_id": null,
"file_name": "icon.jpg",
"content_url": "https://company.zendesk.com/hc/article_attachments/1428/icon.jpg",
"content_type": "application/image",
"size": 58298,
"inline": true
}
}
Utilisez content_url pour mettre l’URL de l’image à jour dans le code HTML de l’article.
Consultez Association de pièces jointes aux articles en bloc.
Importation des commentaires d’articles
Pour importer les commentaires, il vous faut un ID d’auteur et l’ID de l’article. Les agents et les utilisateurs finaux peuvent être auteurs de commentaires. Consultez la section sur la création de commentaires dans la documentation destinée aux développeurs.
Remarque - L’auteur d’un commentaire est automatiquement abonné à l’article commenté. Si le Centre d’aide est activé, il reçoit une notification par e-mal à la création du commentaire.
Migration du contenu vers la communauté
Pour l’importation du contenu de la communauté, vous devez prendre en compte beaucoup des mêmes points que pour l’importation d’une base de connaissances. Vous devez importer les utilisateurs pour affecter des auteurs aux publications. Vous devez aussi mapper la structure de votre ancien contenu de la communauté avec la structure à deux niveaux de la communauté du Centre d’aide :
Création de segments d’utilisateurs (facultatif)
Si vous voulez restreindre l’accès à certains sujets, vous aurez besoin des ID des segments d’utilisateurs. Consultez la section sur la création de segments d’utilisateurs dans la documentation destinée aux développeurs. Vous en aurez besoin quand vous créerez des sujets, pour affecter les restrictions d’accès aux sujets.
Importation des sujets dans la communauté
Consultez la section sur la création de sujets dans la documentation destinée aux développeurs. Le cas échéant, n’oubliez pas définir user_segment_id dans la requête POST.
Zendesk renvoie une réponse JSON avec l’ID du sujet :
{
"topic": {
"id": 115000553548,
"name": "Help Center-Tricks",
...
}
}
Notez l’ID de chaque sujet. Vous en aurez besoin quand vous créerez des sujets, pour affecter les publications à des sujets spécifiques.
Importation des publications dans les sujets
Consultez la section sur la création de publications dans la documentation destinée aux développeurs. En plus de title et details, n’oubliez pas de définir author_id et topic_id dans chaque requête POST.
Contrairement aux articles de la base de connaissances, les auteurs des publications de la communauté peuvent être des agents ou des utilisateurs finaux.
À la création d’une publication, l’auteur est automatiquement abonné à toutes les mises à jour de ce sujet et est notifié à chaque création ou mise à jour d’une publication.
Tous les abonnés à un sujet reçoivent une notification par e-mail à la création de la publication. Pour éviter d’inonder les abonnés de notifications en cas d’importation des publications en bloc, incluez un paramètre notify_subscribers avec la valeur false dans vos requêtes POST.
{
"post": {
"id": 35467,
"author_id": 89567,
"title": "Help!",
"details": "My printer is on fire!",
"notify_subscribers": false,
...
}
}
Importation des commentaires dans les publications
Une fois que vous avez créé les publications et obtenu leurs ID, vous pouvez y ajouter les commentaires associés. Consultez la section sur la création de commentaires dans la documentation destinée aux développeurs.
Les commentaires doivent être créés les uns après les autres. À la création d’un commentaire de publication, l’auteur du commentaire est automatiquement abonné à toutes les mises à jour de ce sujet et est notifié à chaque création ou mise à jour d’une publication.
Tous les abonnés à un sujet reçoivent une notification par e-mail à la création du commentaire. Pour éviter d’inonder les abonnés de notifications, incluez un paramètre notify_subscribers avec la valeur false dans vos requêtes POST.
0 Commentaires
Vous devez vous connecter pour laisser un commentaire.