Se você usa objetos personalizados legados, continuará tendo acesso a seus objetos, registros e relacionamentos. Todos os recursos para auxiliar no seu uso continuado dos objetos personalizados legados foram rotulados como “legado”. A documentação sobre objetos personalizados sem o rótulo “legado” aplica-se apenas à nova experiência de objetos personalizados.
A Zendesk fornece muitos tipos de objetos de dados nativos para o armazenamento e gerenciamento de dados do cliente, incluindo tickets, usuários, organizações etc. No entanto, ela não fornece todos os tipos possíveis de objetos de dados que sua organização pode querer. Por exemplo, você talvez queira associar todo novo ticket a um produto de seu catálogo para ter uma ideia melhor da experiência do cliente quando ele usar produtos diferentes. Os objetos personalizados legados permitem a criação de um mapa de cada novo tipo de objeto na Zendesk e então a criação de registros do objeto com base nesse mapa.
Este artigo abrange as seguintes seções:
- Sobre objetos personalizados legados
- Ativação de objetos personalizados legados
- Definição de um tipo de objeto personalizado legado
- Adição de registros de objetos legados
- Modelos de dados com objetos personalizados legados
- Definição do tipo de relacionamento legado
- Associação de registros relacionados de objetos personalizados legados
- Recuperação de registros relacionados
- Aproveitamento de informações para outros processos
- Configuração de funções e permissões para objetos legados
- Exclusão de tipos de objeto personalizado e tipos de relacionamento
Sobre objetos personalizados legados
Um objeto personalizado legado pode ser sobre qualquer assunto, incluindo um produto, um contrato de serviço ou uma visita de cliente. É possível criar objetos personalizados legados na Central de administração da Zendesk ou com a API e então usar seus objetos personalizados legados para fazer com que sua conta da Zendesk atenda às necessidades da sua empresa. É possível controlar o acesso aos objetos personalizados legados especificando as permissões que se aplicam a cada objeto.
Este guia ensinará a definir um objeto personalizado legado na Central de administração. Ele usará de exemplo uma empresa de locação de imóveis para temporada. Os clientes podem relatar seus problemas com a empresa de locação de imóveis pelo telefone ou pelo chat com a equipe de suporte, que cria tickets para eles. A empresa quer associar cada ticket a um imóvel alugado no Support para ajudar os agentes a atenderem o cliente da melhor forma. Essa empresa também gostaria de usar essas informações para entender melhor a experiência do cliente em cada local com o objetivo de planejar melhorias aos imóveis.
O vídeo a seguir fornece uma visão geral dos objetos personalizados legados na Central de administração, mas observe que a interface agora tem uma nova aparência:
Aprimoramento dos objetos personalizados legados (6:02)
Limitações para objetos personalizados legados
As limitações a seguir se aplicam a objetos personalizados legados e registros.
- Cada conta pode ter no máximo 50 objetos personalizados legados.
- Support Enterprise, Suite Team e Growth: 100.000 registros de objetos personalizados
- Suite Professional: 250.000 registros de objetos personalizados
- Suite Enterprise: 1.000.000 registros de objetos personalizados
- Suite Enterprise Plus: 25.000.000 registros de objetos personalizados
Ativação de objetos personalizados legados
Os objetos personalizados legados estão disponíveis apenas para contas em que o recurso foi ativado antes de setembro de 2023. Se você está começando a usar dados personalizados no Zendesk, confira a nova experiência de objeto personalizado.
Definição de um tipo de objeto personalizado legado
Para a empresa de locação de imóveis para temporada, você quer que cada imóvel seja representado por um registro de objeto personalizado legado na Zendesk. Se a empresa comprar outro imóvel para locação, basta adicionar um registro de objeto para representá-lo.
Os imóveis para locação têm alguns atributos em comum. Por exemplo, todos os imóveis possuem endereço, valor para locação semanal, número de quartos entre outros. Os valores do atributo variam de acordo com o imóvel para locação. Digamos que a locação de um apartamento de dois quartos em Lisboa custe US$ 600 por semana enquanto uma casa de três quartos em Aspen, US$ 1.100 por semana.
Da mesma forma, os objetos personalizados do mesmo tipo (como um tipo de "imóvel para locação") do Sunshine possuem os mesmos atributos. Os atributos de um objeto personalizado legado personalizado são definidos em um mapa chamado tipo de objeto.
Tecnicamente, um tipo de objeto consiste em uma chave e um esquema que descreve os atributos. A chave é nome que você deseja usar para identificar o tipo de objeto. Você digita a chave no campo Nome do objeto ao criar um tipo de objeto. Exemplo: "rental_property".
É possível definir todos os tipos de atributos a um imóvel para locação. Para simplificarmos o exemplo, você decide usar os atributos a seguir para um novo objeto personalizado com uma chave chamada "rental_property".
| Nome | Tipo | Obrigatório | Comentário |
|---|---|---|---|
| id | cadeia de caracteres | sim | Identificador exclusivo atribuído pela empresa ao imóvel para locação |
| bedrooms | número | não | Número de quartos |
| address | cadeia de caracteres | não | Endereço do imóvel para locação |
| country | cadeia de caracteres | não | País do imóvel para locação |
| cleaning_service | cadeia de caracteres | não | Serviço local de limpeza |
| cleaning_service_phone | cadeia de caracteres | não | Telefone do serviço local de limpeza |
| pets_allowed | booliano | sim | Se animais são permitidos ou não na propriedade |
Esse é o seu esquema. Repare que o esquema não contém informações sobre um imóvel para locação específico. Ele apenas descreve essas informações. Para saber mais, consulte Criação de um esquema para um objeto personalizado legado.
Como criar um tipo de objeto personalizado legado
- Na Central de administração, clique em
Objetos e regras na barra lateral e selecione Objetos personalizados > Objetos legados. - Clique em Adicionar objeto.
- Em Nome do objeto, insira a chave do objeto como "rental_property".
Sua chave deve atender aos requisitos a seguir:
- Deve ser exclusiva;
- Conter apenas caracteres alfanuméricos (a-z, 0-9), sublinhados (_) e traços (-);
- Ter no mínimo 2 e no máximo 32 caracteres.
- Clique em Adicionar propriedade para definir a nova propriedade.
- Insira os valores a seguir no formulário Adicionar propriedade no painel direito:
- Nome - id
- Tipo - string
- Descrição - identificador exclusivo atribuído pela empresa ao imóvel para locação
- Obrigatório - campo deve estar marcado
- Clique em Adicionar propriedade se deseja continuar a criar seu esquema.
- Insira os valores da segunda propriedade no formulário Adicionar propriedade.
- Continue clicando em Adicionar propriedade para adicionar outras propriedades na tabela de esquema.
- Clique em Salvar.
Após abri-lo novamente, o tipo de objeto legado terá a aparência a seguir:
Após salvar seu objeto, você pode configurar as permissões de acesso com base na função para definir as permissões de agentes e usuários finais para o objeto e os registros de relacionamento. Consulte Configuração de funções e permissões para objetos.
Adição de registros de objetos legados
Uma vez criado o tipo de objeto do imóvel para locação na Central de administração, os desenvolvedores em sua organização poderão usar a API do Sunshine para criarem um registro de objeto personalizado legado para cada imóvel da empresa. Eles também podem usar a API para lerem, atualizarem e apagarem os registros. Os registros do objeto legado nada mais são do que registros do banco de dados com propriedades definidas.
Os dados que um desenvolvedor inclui na solicitação da API para criar um registro de imóvel para locação são definidos pelo tipo de objeto que você especificou, que para o tipo "rental_property" consiste em atributos chamados "id", "bedrooms", "address", "country", "cleaning_service" e "cleaning_service_phone". Exemplo:
{
"data": {
"type": "rental_property",
"attributes": {
"id": "fr-021",
"bedrooms": 2,
"address": "11 rue Laurier, Saint-Tropez",
"country": "France"
"cleaning_service": "tropez-nettoyage"
"cleaning_service_phone": "011.33.06.55.47.54.74 "
}
}
}Se você deseja recuperar os registros em um outro momento, um desenvolvedor pode usar vários pontos de extremidade diferentes para recuperá-los. Consulte sobre os registros de objetos legados na documentação da API.
Se a empresa fizer uma alteração no imóvel para locação como contratar um novo serviço de limpeza, o desenvolvedor poderá usar o ponto de extremidade Update legacy object record para atualizar o registro de objeto desse imóvel para locação.
Se a empresa vender o imóvel para locação, o desenvolvedor poderá usar o ponto de extremidade Delete legacy object record.
Se a empresa comprar outro imóvel, o desenvolvedor poderá usar o ponto de extremidade Create legacy object record.
Modelos de dados com objetos personalizados legados
Para usar os dados do imóvel para locação de forma mais significativa, é possível estabelecer uma relação entre o seu tipo de "rental_property" e outros tipos de objeto na Zendesk. Por exemplo, as informações sobre um imóvel específico não são muito úteis para um gerente a menos que elas estejam associadas aos tickets que os hóspedes enviaram sobre o imóvel. Observe que os tickets são apenas outro tipo de objeto na Zendesk.
Os objetos personalizados conseguem comportar vários relacionamentos entre os tipos de objeto:
-
Um para um - ambos os tipos de objeto podem ter apenas um registro em cada lado do relacionamento. Por exemplo, um ticket só estaria associado a um imóvel para locação e um imóvel só estaria associado a um ticket. No caso de locações para temporada, essa não é uma opção viável. Um imóvel para locação pode ter mais de um ticket associado a ele.
-
Um para muitos - cada objeto do primeiro tipo de objeto está relacionado a nenhum, a um ou a muitos objetos do segundo tipo de objeto. Por exemplo, um imóvel para locação pode estar associado a nenhum, a um ticket ou a muitos tickets.
-
Muitos para muitos - cada objeto do primeiro tipo de objeto está relacionado a nenhum, a um ou a muitos objetos do segundo tipo de objeto, e cada objeto do segundo tipo de objeto está relacionado a nenhum, a um ou a muitos objetos do primeiro tipo de objeto. Você define o tipo de relacionamento muitos para muitos com dois tipos de relacionamento um para muitos.
O relacionamento pode ser entre:
- Dois tipos de objeto personalizado legado (entre o tipo de objeto "rental_property" e o "guest_contract", por exemplo)
- Um tipo de objeto personalizado legado e qualquer tipo de objeto da Zendesk como: tickets, usuários, artigos, organizações, grupos ou chats
- Dois tipos de objeto padrão do Zendesk.
Definição do tipo de relacionamento legado
Assim como um tipo de objeto é um mapa para a criação de registros de objeto, um tipo de relacionamento é um mapa para a criação de relacionamento entre dois tipos de objeto específicos. No caso do exemplo da locação para temporada, você deseja definir um tipo de relacionamento "um imóvel para locação tem muitos tickets" entre o tipo de objeto "rental_property" personalizado e o tipo de objeto padrão do ticket do Zendesk.
Se você usa a Zendesk Sell, pode também criar um relacionamento entre os objetos da Zendesk Sell como lead, oportunidade ou contato.
A definição do tipo de relacionamento não cria uma associação entre dois tipos de registros específicos. Ela apenas descreve o relacionamento. Feita a definição do seu tipo de relacionamento, você pode criar o registro de relacionamento que associa um ticket específico a um imóvel para locação específico. Como esses registros de relacionamento são cumulativos, com cada registro que associa um ticket a um imóvel para locação, começaremos a entender melhor os problemas em cada imóvel para locação. O Sunshine pode agrupar os tickets por imóvel para locação com base no tipo de relacionamento que você definiu: um imóvel para locação tem muitos tickets.
Como criar um tipo de relacionamento legado
- Na Central de administração, clique em Objetos e regras na barra lateral e selecione Objetos personalizados > Relacionamentos.
- Clique em Adicionar tipo de relacionamento.
- Em Nome do relacionamento, insira "rental_prop_has_many_tickets".
Sua chave deve atender aos requisitos a seguir:
- Deve ser exclusiva;
- Conter apenas caracteres alfanuméricos (a-z, 0-9), sublinhados (_) e traços (-);
- Ter no mínimo 2 e no máximo 32 caracteres.
- Selecione os valores a seguir nos menus:
- Origem - rental_property
- Tipo - 1:Muitos
- Destino - zen:ticket
Sua página terá a aparência a seguir:
- Clique em Salvar.
Associação de registros relacionados de objetos personalizados legados
Uma vez definido o tipo de relacionamento, é possível iniciar a associação dos registros relacionados com base no tipo de relacionamento.
Você associa um registro de um tipo de objeto a um registro de outro tipo de objeto ao criar um registro de relacionamento (que não deve ser confundido com um tipo de relacionamento). Para sua empresa de locação de imóveis para temporada, você pode criar um registro de relacionamento entre um ticket específico e um imóvel para locação específico.
Um registro de relacionamento consiste em IDs de dois registros de objeto relacionados e seu tipo de relacionamento. O registro de relacionamento não contém informações reais sobre o problema do locatário ou do imóvel para locação. Ele contém apenas a ID do registro do ticket e a ID do registro do imóvel para locação. O Sunshine usa essas IDs para recuperar os registros relacionados.
O registro de relacionamento é regido por um tipo de relacionamento que você criou: o tipo um para muitos cujo nome é "rental_property_has_many_tickets" no qual cada ticket pode ser associado a apenas um imóvel para locação, mas cada imóvel pode ser associado a vários tickets.
Para criar um registro de relacionamento, um desenvolvedor de sua equipe pode fazer uma solicitação POST ao ponto de extremidade Create Relationship Record. O objeto JSON que o desenvolvedor inclui na solicitação deve especificar o tipo de relacionamento e as IDs dos objetos de "origem" e "destino". Exemplo:
{
"data": {
"relationship_type": "rental_property_has_many_tickets",
"source": "1c771ee0-2c3f-11e7-bf60-e5c3f630b5aa",
"target": "zen:ticket:35437746"
}
}Recuperação de registros relacionados
Um desenvolvedor de sua equipe pode usar o ponto de extremidade List Relationship Records by Object Record para recuperar os registros de relacionamento. Por exemplo, o desenvolvedor pode obter todos os tickets relacionados a um imóvel para locação com uma ID de registro "5d0daa84-aec0-11e7-9a70-416881d66b6d".
Exemplo de resposta:
{
"data": [
{
"id": "c5477230-2e98-11e7-acd9-9dbd5d6450d8",
"target": "zen:ticket:35438118",
"ref": "/api/v2/tickets/35438118"
},
{
"id": "5d3484b5-aec6-11e7-9a70-a12d6a7d800c",
"target": "zen:ticket:35437746",
"ref": "/api/v2/tickets/35437746"
}
],
"links": {
"previous":null,
"next":null
}
}No exemplo, o imóvel para locação tem dois tickets, 35438118 e 35437746, associados a ele. Você pode usar as informações para visualizar os tickets.
Aproveitamento de informações para outros processos
É possível usar seus objetos personalizados e registros de relacionamento para resolver problemas do mundo real, aprimorar processos existentes ou simplesmente entender melhor de seus clientes. Por exemplo, um desenvolvedor de sua equipe pode usar um objeto personalizado do imóvel para locação para criar um aplicativo do Zendesk que mostre detalhes sobre o imóvel ao agente que está trabalhando nesse ticket.
O aplicativo também pode criar o registro de relacionamento entre o ticket e o imóvel para locação quando o agente muda o status do ticket de novo para aberto. Então você pode usar a API do Sunshine para gerar relatórios com a listagem de todos os tickets para cada imóvel para locação e usar essas informações para planejar melhorias.
Configuração de funções e permissões para objetos legados
Ao criar um objeto personalizado legado, é possível definir permissões depois de salvar o esquema de objeto. Após você salvar o esquema de objeto, um conjunto de permissões padrão é exibido na aba Permissões. As permissões padrão para um objeto legado fornecem permissões completas (criar, ler, atualizar e apagar) para agentes e nenhuma permissão para usuários finais.
Como configurar funções e permissões para um objeto personalizado legado
- Na Central de administração, clique em Objetos e regras na barra lateral e selecione Objetos personalizados > Objetos legados.
- Clique em Adicionar objeto ou selecione um objeto existente para editar.
- Clique na aba Permissões.
- Selecione a função Agentes ou Usuários finais para definir as permissões.
- No painel de Agentes ou Usuários finais, selecione as permissões que você deseja ativar para as respectivas funções.
As opções são: Criar, Ler, Atualizar e Apagar.
- Clique em Salvar.
Uma mensagem informando que o objeto legado foi salvo é enviada para você e as permissões atualizadas são incluídas na tabela.
Exclusão de tipos de objeto personalizado e tipos de relacionamento
Você pode apagar um tipo de objeto personalizado ou um tipo de relacionamento na Central de administração, mas não um registro de objeto personalizado ou um registro de relacionamento. Esta seção descreve como apagar um tipo de objeto personalizado ou um tipo de relacionamento na Central de administração. Você não pode apagar um tipo de objeto/relacionamento se ele tem relacionamentos ou registros existentes associados a ele. Para apagar um registro de objeto personalizado ou apagar um registro de relacionamento, use a API Sunshine.
Como apagar um tipo de objeto personalizado
- Na Central de administração, clique em Objetos e regras na barra lateral e selecione Objetos personalizados > Objetos.
- Passe o mouse sobre o tipo de objeto personalizado que você deseja apagar e clique no ícone de lixeira ao lado do tipo.
- Quando a mensagem de confirmação for exibida, clique em Apagar para confirmar a exclusão.
Como apagar um tipo de relacionamento
- Na Central de administração, clique em Objetos e regras na barra lateral e selecione Objetos personalizados > Relacionamentos.
- Passe o mouse sobre o tipo de relacionamento que você deseja apagar e clique no ícone de lixeira ao lado do tipo.
- Quando a mensagem de confirmação for exibida, clique em Apagar para confirmar a exclusão.