Migración del contenido existente al Centro de ayuda

Este artículo ofrece una descripción general del proceso de migración del contenido existente a la nueva base de conocimientos y comunidad del Centro de ayuda.

Temas que se tratan:

• Migrar contenido a la base de conocimientos
• Migrar contenido a la comunidad

Migrar contenido a la base de conocimientos

El proceso para migrar contenido de un sistema externo al Centro de ayuda sigue varios pasos en los que los datos de un paso son necesarios para los pasos subsiguientes.

La planificación es imprescindible. Un aspecto importante es mapear la estructura del contenido heredado con la estructura de tres niveles del Centro de ayuda:

Importar los autores como usuarios de Zendesk

Primero, importe los autores de todos los artículos como usuarios de Zendesk. Los autores de artículos en el Centro de ayuda deben ser usuarios de Zendesk con el rol de “agente”. Un agente en Zendesk no siempre es una persona encargada de resolver tickets. Consulte Introducción a los roles de usuario de Zendesk Support.

Para crear usuarios de Zendesk con la API, consulte Create User en la documentación relacionada con la API de Zendesk. Asegúrese de establecer el atributo role en “agente” en cada solicitud POST.

Después de crear un usuario correctamente, Zendesk devuelve los detalles del usuario en la respuesta JSON, junto con la nueva ID del usuario:

{
  "user": {
    "id":   9873843,
    "name": "Roger Wilco",
    ...
  }
}

Apunte la ID de cada usuario. Las ID se necesitarán para establecer el atributo author_id de cada artículo creado en el Centro de ayuda.

Sugerencia: Es aconsejable crear un mapa de cada ID de autor y sus artículos heredados.

Si piensa usar organizaciones en segmentos de usuario para dividir las secciones, las organizaciones tienen que crearse antes de crear los usuarios. Luego puede asignar la ID de organización al usuario a la hora de crearlo. Consulte Create Organization en la documentación para programadores. Si los usuarios van a pertenecer a varias organizaciones, utilice afiliaciones a organizaciones para agregar organizaciones al registro del usuario.

Crear categorías en la base de conocimientos

Consulte Create Category en la documentación de la API del Centro de ayuda. Las categorías son colecciones de secciones.

Después de crear una categoría, Zendesk devuelve una respuesta JSON con la nueva ID de la categoría:

{
  "category": {
    "id":          37486578,
    "name":        "Super Hero Tricks",
    "description": "This category contains a collection of Super Hero tricks",
    "locale":      "en-us",
    "position":    2,
    ...
  }
}

Apunte la ID de cada categoría. A la hora de crear las secciones más adelante, se necesitarán las ID para asignar secciones a categorías específicas.

Crear segmentos de usuarios (opcional)

Si desea restringir el acceso a ciertas secciones del Centro de ayuda, puede asignar segmentos de usuarios a dichas secciones. Consulte Create User Segment en la documentación de la API del Centro de ayuda.

Después de crear un segmento de usuarios, Zendesk devuelve una respuesta JSON con la nueva ID del segmento:

{
  "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
  }
}

Apunte la ID de cada segmento de usuarios. A la hora de crear las secciones más adelante, necesitará las ID de los segmentos para especificar las restricciones de acceso a las secciones.

Crear secciones en las categorías

Consulte Create Section en la documentación de la API del Centro de ayuda. Las secciones son colecciones de artículos.

Asegúrese de establecer category_id y user_segment_id (si hay) en cada solicitud POST. Zendesk devuelve una respuesta JSON con la nueva ID de la sección:

{
  "section": {
    "id":          3457836,
    "name":        "Avionics",
    "description": "This section contains articles on flight instruments",
    "locale":      "en-us",
    "category_id": 3465,
    ...
  }
}

Apunte la ID de cada sección. A la hora de crear los artículos más adelante, necesitará las ID de sección para asignar artículos a determinadas secciones.

Crear artículos en las secciones

Una vez que se cuente con todas las ID de secciones y de usuarios de los pasos anteriores, se pueden crear los artículos. Consulte Create Article en la documentación de la API del Centro de ayuda. Además de title y body, asegúrese de establecer author_id y section_id en cada solicitud POST.

Observe que todos los autores son suscritos automáticamente a sus artículos. Si el Centro de ayuda está activado, recibirán una notificación por correo electrónico cuando se cree el artículo.

Zendesk devuelve una respuesta JSON como la siguiente:

{
  "article": {
    "id":                37486578,
    "author_id":         3465,
    "promoted":          false,
    "position":          42,
    "comments_disabled": true,
    "section_id":        98838,
    ...
  }
}

Cargar archivos adjuntos (si es necesario)

Si un artículo tiene imágenes incorporadas que no residen en un servidor de archivos público como Amazon S3, cargue las imágenes en el Centro de ayuda. Consulte Create Unassociated Attachment en la documentación para programadores. No olvide establecer el parámetro inline en true.

Zendesk devuelve una respuesta JSON con un URL (content_url) para el archivo adjunto:

{
  "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
  }
}

Use el content_url para actualizar el URL de la imagen en el código HTML del artículo.

Consulte también Associate Attachments in Bulk to Article.

Importar comentarios de los artículos

Para importar comentarios, es necesario tener una ID de autor y la ID del artículo. Tanto agentes como usuarios finales pueden ser autores de comentarios. Consulte Create Comment en la documentación para programadores.

Observe que a los autores de comentarios se les suscribe automáticamente al artículo. Si el Centro de ayuda está activado, recibirán una notificación por correo electrónico cuando se cree el comentario.

Migrar contenido a la comunidad

Para importar contenido en la comunidad deben tomarse en cuenta las mismas consideraciones que al importar contenido en una base de conocimientos. Se deben importar usuarios para asignar autores a las publicaciones. También es necesario mapear la estructura del contenido de la comunidad heredada con la estructura de dos niveles de la comunidad del Centro de ayuda:

Crear segmentos de usuarios (opcional)

Si desea restringir el acceso a ciertos temas, deberá asignar ID de segmentos de usuarios. Consulte Create User Segment en la documentación para programadores. A la hora de crear los temas más adelante, necesitará las ID de los segmentos de usuarios para especificar las restricciones de acceso a los temas.

Importar temas en la comunidad

Consulte Create Topic en la documentación para programadores. Si corresponde, asegúrese de establecer user_segment_id en la solicitud POST.

Zendesk devuelve una respuesta JSON con la ID del tema:

{
  "topic": {
    "id":   115000553548,
    "name": "Help Center-Tricks",
    ...
  }
}

Apunte la ID de cada tema. A la hora de crear los temas más adelante, necesitará las ID de los temas para asignar publicaciones a temas específicos.

Importar publicaciones en los temas

Consulte Create Posts en la documentación para programadores. Además de title y details, asegúrese de establecer author_id y topic_id en cada solicitud POST.

A diferencia de los artículos de la base de conocimientos, los autores de las publicaciones de la comunidad pueden ser agentes o usuarios finales.

Al momento de crearse una publicación, se suscribe automáticamente a su autor a todas las actualizaciones sobre ese tema, y cada vez que se crea una nueva publicación o se actualiza la actual, se le envía una notificación.

Todas las personas suscritas al mismo tema recibirán una notificación por correo electrónico cuando se cree la publicación. Para evitar abrumar a los suscriptores con notificaciones en caso de importar publicaciones de forma masiva, incluya un parámetro notify_subscribers con un valor de false en sus solicitudes POST.

{
  "post": {
    "id":        35467,
    "author_id": 89567,
    "title":     "Help!",
    "details":   "My printer is on fire!",
    "notify_subscribers": false,
    ...
  }
}

Importar comentarios en las publicaciones

Una vez creadas las publicaciones y obtenidas sus ID, podrá agregar sus comentarios relacionados. Consulte Create Comment en la documentación para programadores.

Solo se puede crear un comentario a la vez. Al momento de crearse el comentario de una publicación, se suscribe automáticamente a su autor a todas las actualizaciones sobre ese tema, y cada vez que se crea una nueva publicación o se actualiza la actual, se le envía una notificación.

Todas las personas suscritas al mismo tema recibirán una notificación por correo electrónico cuando se cree un comentario. Para evitar abrumar a los suscriptores con todas las notificaciones, incluya un parámetro notify_subscribers con un valor de false en sus solicitudes POST.