Skip Moore

Hay muchas maneras de migrar el contenido de un centro de ayuda a otro. Este artículo trata principalmente de cómo usar la API del centro de ayuda para importar contenido mediante programación y ofrece una descripción general del proceso de migración del contenido existente a la nueva base de conocimientos del centro de ayuda y la comunidad. También se puede migrar el contenido usando los siguientes métodos:

• Copiar/pegar: si solo desea migrar unos cuantos artículos, la manera más fácil y rápida es simplemente copiar y pegar el contenido del centro de ayuda anterior en un artículo de Guide nuevo.
• Servicios profesionales: si tiene que hacer migraciones grandes o complicadas, puede contratar a Zendesk para que le ayude con la migración.
• Aplicaciones de socios: puede explorar el marketplace de aplicaciones de Zendesk para buscar aplicaciones de socios como Help Desk Migration.

En este artículo se tratan los siguientes temas:

• Migrar contenido a la base de conocimientos
  • Importar los autores como usuarios de Zendesk
  • Crear categorías en la base de conocimientos
  • Crear segmentos de usuarios (opcional)
  • Crear secciones en las categorías
  • Crear artículos en las secciones
  • Cargar archivos adjuntos (si es necesario)
  • Importar comentarios de los artículos
• Migrar contenido a la comunidad
  • Crear segmentos de usuarios (opcional)
  • Importar temas en la comunidad
  • Importar publicaciones en los temas
  • Importar comentarios en las publicaciones

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, debe importar los autores de todos sus artículos como usuarios de Zendesk con el rol "agente" (un agente en Zendesk no es necesariamente alguien que resuelve tickets; consulte Introducción a los roles de usuario de Zendesk Support).

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

Una vez creado 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",
    ...
  }
}

Anote la ID de cada usuario porque se necesitarán las ID para establecer el atributo author_id de cada artículo que se cree en el centro de ayuda.

Si piensa usar organizaciones en segmentos de usuarios para dividir las secciones, tiene que crear las organizaciones antes de crear los usuarios. Entonces podrá asignar la ID de la organización al usuario a la hora de crearlo (consulte Create Organization). 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

Las categorías son colecciones de secciones (consulte Create Category). Una vez creada 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,
    ...
  }
}

Anote la ID de cada categoría, porque a la hora de crear 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 las secciones (consulte Create User Segment).

Una vez creado un segmento de usuarios, Zendesk devuelve una respuesta JSON con la nueva ID del segmento de usuarios:

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

Anote la ID de cada segmento de usuarios, porque a la hora de crear secciones más adelante, se necesitará la ID del segmento para asignar restricciones de acceso a las secciones.

Crear secciones en las categorías

Las secciones son colecciones de artículos (consulte Create Section). 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,
    ...
  }
}

Anote la ID de cada sección, porque a la hora de crear artículos más adelante, se necesitarán las ID de sección para asignar artículos a secciones específicas.

Crear artículos en las secciones

Una vez que tenga todas las ID de secciones y las ID de usuarios de los pasos anteriores, podrá crear artículos (consulte Create Article). Además de title y body, asegúrese de establecer author_id y section_id en cada solicitud POST.

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). Asegúrese de 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
  }
}

Utilice content_url para actualizar el URL de la imagen en el HTML del artículo (consulte Associate Attachments in Bulk to Article).

Importar comentarios de los artículos

Para importar comentarios, se necesita la ID de un autor y la ID del artículo. Tanto los agentes como los usuarios finales pueden ser autores de comentarios (consulte Create Comment).

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, necesitará las ID de los segmentos de usuarios (consulte Create User Segment). 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

Si se aplica, asegúrese de establecer user_segment_id en la solicitud POST (consulte Create Topic).

Zendesk devuelve una respuesta JSON con la ID del tema:

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

Anote la ID de cada tema, porque 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

Además de title y details, asegúrese de establecer author_id y topic_id en cada solicitud POST (consulte Create 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 crear una publicación, se suscribe automáticamente al autor a todas las actualizaciones de 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).

Solo se puede crear un comentario a la vez. Al momento de crear el comentario de una publicación, se suscribe automáticamente al autor a todas las actualizaciones del 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.

Steven Loeb, This is the 1st time I have heard of not creating the project links. Could you post here https://github.com/zendesklabs/project_app/issues anything you have on replications steps 

I have fixed the code and submitted the fix to the labs team. If you want to use it right now feel free to download it and upload it as private app.