Dieser Beitrag bietet einen allgemeinen Überblick über das Migrieren vorhandener Inhalte in die Wissensdatenbank und Community Ihres neuen Help Centers.
Behandelte Themen:
Migrieren von Inhalten in die Wissensdatenbank
Die Migration von Inhalten aus einem externen System in das Help Center umfasst mehrere Schritte, wobei die Daten aus einem Schritt jeweils für die weiteren Schritte benötigt werden.
Die richtige Planung ist entscheidend. Sie müssen die Struktur Ihrer vorhandenen Inhalte den drei Schichten der Help-Center-Struktur zuordnen:
Importieren Ihrer Autoren als Zendesk-Benutzer
Importieren Sie als Erstes die Autoren aller Ihrer Beiträge als Zendesk-Benutzer. Die Autoren Ihrer Help-Center-Beiträge müssen als Zendesk-Benutzer mit der Rolle „Agent“ eingerichtet sein. Agenten sind in Zendesk nicht nur für das Lösen von Tickets zuständig. Weitere Informationen finden Sie unter Überblick über die Benutzerrollen in Zendesk Support.
Eine Anleitung zum Erstellen von Zendesk-Benutzern mit der API finden Sie in der Dokumentation der Zendesk-API unter Create User. Achten Sie darauf, das Attribut role in jeder POST-Anfrage auf „agent“ zu setzen.
Nachdem ein Benutzer erstellt wurde, gibt Zendesk die Details des Benutzers einschließlich seiner neuen ID in der JSON-Antwort zurück:
{
"user": {
"id": 9873843,
"name": "Roger Wilco",
...
}
}
Notieren Sie sich die ID des jeweiligen Benutzers. Sie benötigen die ID für die Einstellung des author_id-Attributs in den Beiträgen, die Sie im Help Center erstellen.
Tipp: Am besten legen Sie eine Liste der IDs und der vorhandenen Beiträge der einzelnen Autoren an.
Wenn Sie Organisationen zur Unterteilung von Benutzersegmenten verwenden möchten, müssen Sie zuerst die Organisationen und dann die Benutzer erstellen. Auf diese Weise können Sie einem Benutzer beim Erstellen direkt die gewünschte Organisations-ID zuweisen. Weitere Informationen finden Sie in der Dokumentation für Entwickler unter Create Organization. Wenn Benutzer mehreren Organisationen angehören, fügen Sie diese den Benutzerdatensätzen in Form von Organisationsmitgliedschaften hinzu.
Erstellen von Kategorien in der Wissensdatenbank
Weitere Informationen finden Sie in der Dokumentation zur Help-Center-API unter Create Category. Kategorien sind Sammlungen von Abschnitten.
Nachdem Sie eine Kategorie erstellt haben, gibt Zendesk eine JSON-Antwort mit der neuen ID der Kategorie zurück:
{
"category": {
"id": 37486578,
"name": "Super Hero Tricks",
"description": "This category contains a collection of Super Hero tricks",
"locale": "en-us",
"position": 2,
...
}
}
Notieren Sie sich die ID der jeweiligen Kategorie. Wenn Sie später die Abschnitte erstellen, benötigen Sie die IDs, um diese Abschnitte bestimmten Kategorien zuzuordnen.
Erstellen von Benutzersegmenten (optional)
Wenn Sie den Zugriff auf bestimmte Abschnitte im Help Center beschränken möchten, können Sie den Abschnitten Benutzersegmente zuweisen. Weitere Informationen finden Sie in der Dokumentation zur Help-Center-API unter Create User Segment.
Nachdem Sie ein Benutzersegment erstellt haben, gibt Zendesk eine JSON-Antwort mit der neuen ID des Benutzersegments zurück:
{
"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
}
}
Notieren Sie sich die ID des jeweiligen Benutzersegments. Wenn Sie später die Abschnitte erstellen, benötigen Sie die IDs für die Zuweisung von Zugriffsbeschränkungen.
Erstellen von Abschnitten in den Kategorien
Weitere Informationen finden Sie in der Dokumentation zur Help-Center-API unter Create Section. Abschnitte sind Sammlungen von Beiträgen.
Achten Sie darauf, in jeder POST-Anfrage die Attribute category_id und user_segment_id (sofern vorhanden) einzustellen. Zendesk gibt eine JSON-Antwort mit der neuen ID des Abschnitts zurück:
{
"section": {
"id": 3457836,
"name": "Avionics",
"description": "This section contains articles on flight instruments",
"locale": "en-us",
"category_id": 3465,
...
}
}
Notieren Sie sich die ID des jeweiligen Abschnitts. Wenn Sie später die Beiträge erstellen, benötigen Sie die IDs für deren Zuweisung zu bestimmten Abschnitten.
Erstellen der Beiträge in den Abschnitten
Wenn Sie die Abschnitts- und Benutzer-IDs aus den vorherigen Schritten notiert haben, können Sie die Beiträge erstellen. Weitere Informationen finden Sie in der Dokumentation zur Help-Center-API unter Create Article. Achten Sie darauf, in jeder POST-Anfrage neben title und body auch die Attribute author_id und section_id einzustellen.
Beachten Sie, dass Autoren ihre Beiträge automatisch abonnieren. Nach Aktivierung des Help Centers erhalten sie eine E-Mail-Benachrichtigung, wenn der Beitrag erstellt wird.
Zendesk gibt eine JSON-Antwort zurück, die wie folgt aussieht:
{
"article": {
"id": 37486578,
"author_id": 3465,
"promoted": false,
"position": 42,
"comments_disabled": true,
"section_id": 98838,
...
}
}
Hochladen von Anhängen (falls erforderlich)
In Beiträge eingebettete Bilder, die nicht auf einem öffentlichen Dateiserver wie Amazon S3 gehostet werden, müssen in das Help Center hochgeladen werden. Weitere Informationen finden Sie in der Dokumentation für Entwickler unter Create Unassociated Attachment. Achten Sie darauf, den Parameter inline auf true zu setzen.
Zendesk gibt eine JSON-Antwort mit einer URL (content_url) für den Anhang zurück:
{
"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
}
}
Aktualisieren Sie die URL-Adresse des Bildes im HTML-Code des Beitrags mit der unter content_url angegebenen Adresse.
Siehe auch Associate Attachments in Bulk to Article.
Importieren von Beitragskommentaren
Zum Importieren von Kommentaren benötigen Sie eine Autoren-ID und die ID des Beitrags. Kommentare können sowohl von Agenten als auch von Endbenutzern geschrieben werden. Weitere Informationen finden Sie in der Dokumentation für Entwickler unter Create Comment.
Beachten Sie, dass Kommentatoren die von ihnen kommentierten Beiträge automatisch abonnieren. Nach Aktivierung des Help Centers, erhalten sie eine E-Mail-Benachrichtigung, wenn der Kommentar erstellt wird.
Migrieren von Inhalten in die Community
Das Importieren von Community-Inhalten ist in vielerlei Hinsicht mit dem Importieren von Inhalten in die Wissensdatenbank vergleichbar. Sie müssen Benutzer importieren, um den Posts Autoren zuzuweisen. Außerdem müssen Sie die Struktur Ihrer vorhandenen Community-Inhalte den zwei Schichten der Help Center Community-Struktur zuordnen:
Erstellen von Benutzersegmenten (optional)
Wenn Sie den Zugriff auf bestimmte Themen beschränken möchten, benötigen Sie Benutzersegment-IDs. Weitere Informationen finden Sie in der Dokumentation für Entwickler unter Create User Segment. Wenn Sie später die Themen erstellen, benötigen Sie die IDs für die Zuweisung von Zugriffsbeschränkungen.
Importieren von Themen in die Community
Weitere Informationen finden Sie in der Dokumentation für Entwickler unter Create Topic. Achten Sie gegebenenfalls darauf, das Attribut user_segment_id in der POST-Anfrage einzustellen.
Zendesk gibt eine JSON-Antwort mit der ID des Themas zurück:
{
"topic": {
"id": 115000553548,
"name": "Help Center-Tricks",
...
}
}
Notieren Sie sich die ID des jeweiligen Themas. Wenn Sie später die Themen erstellen, benötigen Sie die IDs für die Zuweisung von Posts.
Importieren von Posts in die Themen
Weitere Informationen finden Sie in der Dokumentation für Entwickler unter Create Post. Achten Sie darauf, in jeder POST-Anfrage neben title und details auch die Attribute author_id und topic_id einzustellen.
Im Gegensatz zu Beiträgen in der Wissensdatenbank können Community-Posts sowohl von Agenten als auch von Endbenutzern geschrieben werden.
Der Autor eines Posts abonniert das betreffende Thema automatisch und erhält eine Benachrichtigung, wenn neue Post hinzugefügt oder vorhandene Posts aktualisiert werden.
Alle Abonnenten desselben Themas werden per E-Mail über den neuen Post benachrichtigt. Um die Abonnenten nicht mit Benachrichtigungen zu überhäufen, sollten Sie Ihren POST-Anfragen beim Importieren größerer Mengen von Posts den Parameter notify_subscribers mit dem Wert false hinzufügen.
{
"post": {
"id": 35467,
"author_id": 89567,
"title": "Help!",
"details": "My printer is on fire!",
"notify_subscribers": false,
...
}
}
Importieren vor Kommentaren in die Posts
Nachdem Sie die Posts erstellt und ihre IDs abgerufen haben, können Sie die zugehörigen Kommentare hinzufügen. Weitere Informationen finden Sie in der Dokumentation für Entwickler unter Create Comment.
Kommentare können nur einzeln erstellt werden. Der Autor eines Kommentars abonniert das betreffende Thema automatisch und erhält eine Benachrichtigung, wenn neue Posts hinzugefügt oder vorhandene Posts aktualisiert werden.
Alle Abonnenten desselben Themas werden per E-Mail über den neuen Kommentar benachrichtigt. Um die Abonnenten nicht mit Benachrichtigungen zu überhäufen, sollten Sie Ihren POST-Anfragen den Parameter notify_subscribers mit dem Wert false hinzufügen.
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.