Há diversas maneiras de se migrar o conteúdo de uma central de ajuda para outra. Este artigo tem como foco principal o uso de sua API da central de ajuda para importar o conteúdo de modo programático e fornecer uma visão geral do processo de migração do conteúdo existente para a base de conhecimento e comunidade da nova central de ajuda. Também é possível migrar o conteúdo usando as abordagens a seguir:
- Copiar/colar - se você está apenas migrando uma pequena quantidade de artigos, o modo mais rápido e fácil é simplesmente copiar o conteúdo de uma central de ajuda anterior e colar esse conteúdo em um novo artigo do Guide.
- Serviços profissionais - se você precisa fazer migrações grandes ou complexas, pode contratar a Zendesk para ajudar você com a migração.
- Aplicativos de parceiros - você pode explorar o Marketplace da Zendesk para encontrar aplicativos de parceiros como o Help Desk Migration.
Este artigo abrange os seguintes tópicos:
Migração de conteúdo para sua base de conhecimento
A migração de conteúdo de um sistema externo para a sua central de ajuda é um processo de várias etapas em que uma etapa é obrigatória para as etapas subsequentes.
O planejamento é de extrema importância. Você precisará mapear a estrutura de seu conteúdo legado para a estrutura de três camadas da sua central de ajuda:
Importação de seus autores como usuários do Zendesk
A primeira coisa a fazer é importar os autores de todos os seus artigos como usuários do Zendesk com a função de "agente" (um agente no Zendesk não é necessariamente alguém que resolve os tickets). Consulte Noções básicas sobre as funções de usuário do Zendesk Support.
Para criar os usuários do Zendesk com a API (consulte Criar usuário). É importante definir o atributo role como "agente" em cada solicitação POST.
Após você ter criado um usuário com sucesso, o Zendesk retorna os detalhes do usuário na resposta JSON, incluindo a nova ID do usuário:
{
"user": {
"id": 9873843,
"name": "Roger Wilco",
...
}
}
Guarde a ID de cada usuário, pois você precisará delas para definir o author_id de cada artigo que você criar em sua central de ajuda.
Se você pretende usar organizações em segmentos de usuário para seções segregadas, precisa criar as organizações antes de criar usuários. Você pode atribuir a ID da organização para o usuário quando está criando o usuário (consulte Criar organização). Se seus usuários pertencem a várias organizações, use assinaturas de organização para adicionar organizações para o registro do usuário.
Criação de categorias em sua base de conhecimento
As categorias são coleções de seções (consulte Criar categoria). Após você ter criado uma categoria, o Zendesk retorna uma resposta JSON com a nova ID da categoria:
{
"category": {
"id": 37486578,
"name": "Super Hero Tricks",
"description": "This category contains a collection of Super Hero tricks",
"locale": "en-us",
"position": 2,
...
}
}
Guarde a ID de cada categoria, pois quando você criar as seções mais tarde, precisará das IDs para atribuir seções para categorias específicas.
Criação de segmentos de usuário (opcional)
Se deseja restringir o acesso a determinadas seções em sua central de ajuda, pode atribuir segmentos de usuário para suas seções (consulte Criar segmento de usuário).
Após você ter criado um segmento de usuário, o Zendesk retorna uma resposta JSON com a nova ID do segmento de usuário:
{
"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
}
}
Guarde a ID de cada segmento de usuário, pois quando você criar as seções mais tarde, precisará da ID do segmento para atribuir restrições de acesso às seções.
Criação de seções em suas categorias
As seções são coleções de artigos (consulte Criar seção). É importante definir o atributo category_id e user_segment_id (se houver), em cada solicitação POST. O Zendesk retorna uma resposta JSON com a nova ID da seção:
{
"section": {
"id": 3457836,
"name": "Avionics",
"description": "This section contains articles on flight instruments",
"locale": "en-us",
"category_id": 3465,
...
}
}
Guarde a ID de cada seção, pois quando você criar os artigos mais tarde, precisará das IDs da seção para atribuir artigos para seções específicas.
Criação de artigos em suas seções
Obtidas todas as IDs de seção e de usuário das etapas anteriores, você pode criar artigos (consulte Criar artigos). Além dos atributos title e body, verifique se você definiu os atributos author_id e section_id em cada solicitação POST.
O Zendesk retorna uma resposta JSON semelhante a esta:
{
"article": {
"id": 37486578,
"author_id": 3465,
"promoted": false,
"position": 42,
"comments_disabled": true,
"section_id": 98838,
...
}
}
Atualização de anexos (se necessário)
Se um artigo contiver imagens embutidas que não estão hospedadas em um servidor de arquivos público, como o Amazon S3, carregue as imagens em sua central de ajuda (consulte como criar anexo não associado em Create unassociated attachment). Verifique se você definiu o parâmetro inline como true.
O Zendesk retorna uma resposta JSON com a URL (content_url) para o anexo:
{
"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 content_url para atualizar a URL da imagem no HTML do artigo (consulte como associar anexos em massa ao artigo em Associate attachments in bulk to article).
Importação de comentários de artigos
Para importar comentários, você precisará de uma ID de autor e da ID do artigo. Os agentes e os usuários finais podem ser autores de comentários (consulte Criar comentário).
Migração de conteúdo para sua comunidade
É necessário que você leve em consideração os mesmos aspectos da importação da base de conhecimento para a importação de conteúdo da comunidade. Você precisará também importar usuários para atribuir autores para as publicações. Será necessário também mapear a estrutura de seu conteúdo legado da comunidade para a estrutura de duas camadas da comunidade de sua central de ajuda:
Criação de segmentos de usuário (opcional)
Se deseja restringir alguns tópicos específicos, precisará das IDs de segmentos de usuário(consulte Criar um segmento de usuário). Quando você criar tópicos mais tarde, precisará das IDs do segmento de usuário para atribuir restrições de acesso aos tópicos.
Importação de tópicos em sua comunidade
Se aplicável, verifique se definiu o user_segment_id na solicitação POST (consulte Criar tópico).
O Zendesk retorna uma resposta JSON com a ID do tópico:
{
"topic": {
"id": 115000553548,
"name": "Help Center-Tricks",
...
}
}
Guarde a ID de cada tópico, pois quando você criar os tópicos mais tarde, precisará das IDs dos tópicos para atribuir publicações para tópicos específicos.
Importação de publicações em tópicos
Além dos atributos title e details, verifique se você definiu os atributos author_id e topic_id em cada solicitação POST (consulte Criar publicação).
Diferentemente de artigos da base de conhecimento, os autores das publicações da comunidade podem ser agentes ou usuários finais.
Ao criar uma publicação, o autor se torna automaticamente assinante de todas as atualizações do tópico em questão e será avisado quando uma nova publicação for criada ou atualizada.
Todos os assinantes do mesmo assunto recebem uma notificação por email quando a publicação for criada. Com o intuito de evitar que assinantes recebam muitas notificações quando fizerem a importação em massa de publicações, inclua o parâmetro notify_subscribers com o valor false em suas solicitações POST.
{
"post": {
"id": 35467,
"author_id": 89567,
"title": "Help!",
"details": "My printer is on fire!",
"notify_subscribers": false,
...
}
}
Importação de comentários em publicações
Após criar publicações e obter suas IDs, você poderá adicionar seus comentários associados (consulte Criar comentário).
Você só pode criar um comentário por vez. Ao criar um comentário da publicação, o autor do comentário se torna automaticamente assinante de todas as atualizações do tópico em questão e será avisado quando uma nova publicação for criada ou atualizada.
Todos os assinantes do mesmo assunto recebem uma notificação por email quando o comentário for criado. Com o intuito de evitar que assinantes recebam muitas notificações, inclua o parâmetro notify_subscribers com o valor false em suas solicitações POST.