Receita de fluxo de trabalho: uso da assistência automática para criar problemas no Jira para resolução

Complemento

Copiloto

Você deve ter o complemento Copiloto para usar este recurso.

É comum que os agentes usem o Zendesk para interagir com os usuários finais e, em seguida, usem o Jira para criar problemas quando é necessária a ajuda da equipe de TI ou de engenharia.

Nesta receita, simplificaremos esse processo criando um procedimento de assistência automática para orientar os agentes na solução de problemas comuns e criando automaticamente um problema no Jira para a equipe de TI, caso seja necessária assistência mais especializada.

Este artigo contém os seguintes tópicos:

Meta de fluxo de trabalho
Pré-requisitos
Criação de um projeto do Jira
Criação de um aplicativo do Jira e um cliente OAuth
Obtenção do ID e do segredo do cliente
Localização do ID do Jira Cloud
Registro do cliente OAuth do Jira no Zendesk
Criação de uma conexão entre o Zendesk e o Jira
Criação de uma ação para criar um problema do Jira
Criação de um procedimento para orientar os agentes
Teste do fluxo de trabalho
Personalização do procedimento
Solução de problemas

Meta de fluxo de trabalho

Usaremos a assistência automática para ajudar os agentes a solucionar problemas comuns de TI e, se necessário, criar um problema no Jira para solicitar ajuda da equipe de TI.

Para facilitar esse processo, faremos o seguinte:

No Jira:
- Identifique ou crie um novo projeto do Jira, para que tenhamos um lugar onde criar problemas no Jira.
- Crie um cliente OAuth do Jira.
No Zendesk:
- Registre o cliente OAuth do Jira para que você possa usá-lo para criar um token OAuth.
- Crie uma conexão que facilite criar um token OAuth e armazená-lo com segurança para usar com a ação.
- Crie uma ação que use a conexão para fazer uma chamada à API do Jira e criar um problema no Jira.
- Crie um procedimento que informe à assistência automática quais etapas são necessárias para orientar o agente na criação de um problema no Jira.
- Verifique se tudo está funcionando.

Pré-requisitos

Para executar este fluxo de trabalho, você precisará do seguinte:

Uma instância do Jira Cloud
Dica: considere usar uma nova sandbox do Jira ou uma instância de plano gratuito em vez da sua instância de produção do Jira até que você tenha se familiarizado com o funcionamento de tudo.
Um usuário do Jira com permissões suficientes para criar um projeto, criar problemas dentro desse projeto e criar um cliente OAuth do Jira.
Dica: se você está usando um plano gratuito do Jira, todos os usuários são administradores e têm as permissões necessárias.
Uma conta do Zendesk com o complemento Copiloto.
Um acesso de usuário administrador para a conta do Zendesk.

Criação de um projeto do Jira

No Jira, identifique um projeto para usar ou crie um novo projeto. Pode ser Scrum ou Kanban. Certifique-se de que seu usuário do Jira tenha acesso ao projeto.

Anote a chave do projeto (por exemplo, ENGREQ), pois você precisará dela mais tarde.

Criação de um aplicativo do Jira e um cliente OAuth

Para criar um aplicativo do Jira e a integração com o OAuth 2.0, execute as etapas descritas em Enabling OAuth 2.0 (3LO) (em inglês) na documentação da plataforma Jira Cloud. Configure os valores a seguir.

Ao criar o aplicativo e o cliente OAuth, defina a opção Callback URL como:

https://zis.zendesk.com/api/services/zis/connections/oauth/callback

Observação: é importante usar a URL exatamente conforme mostrada anteriormente. Não altere “zis” para o seu próprio subdomínio. O ZIS é um serviço do Zendesk que gerencia com segurança a interação entre o Zendesk e o Jira.

Ao adicionar uma API ao aplicativo:

Selecione Permissions no menu esquerdo.
Localize Jira API e clique em Add.
Após alguns instantes, o botão Add mudará para Configure.
Clique em Configure.
Localize Jira platform REST API e clique em Edit Scopes.
Certifique-se de que as opções View Jira issue data e Create and manage issues estejam selecionadas.
Isso permitirá que a ação que você criar posteriormente crie, leia e altere problemas no Jira.
Clique em Salvar.

Obtenção do ID e do segredo do cliente

No Jira, obtenha o ID e o segredo do cliente:

Abra o console do desenvolvedor do Jira.
Acesse a aba Settings.
Anote as informações dos campos Client ID e Secret.

Localização do ID do Jira Cloud

Enquanto estiver conectado ao console do desenvolvedor do Jira, acesse:

https://<YOUR_JIRA_SUBDOMAIN>.atlassian.net/_edge/tenant_info

Anote o Cloud ID, pois você precisará dele quando criar a ação posteriormente.

Registro do cliente OAuth do Jira no Zendesk

O registro de seu cliente OAuth do Jira permite que você o utilize no Zendesk, em vez de ter que interagir com ele usando solicitações de API.

Como registrar seu cliente OAuth do Jira no Zendesk

Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Conexões > Clientes OAuth.
Clique em Adicionar cliente.
Preencha os seguintes campos:
- Nome: dê ao cliente um nome significativo para que você possa encontrá-lo facilmente mais tarde (por exemplo, Jira_client).
- OAuth grant type: código de autorização
- ID do cliente: o ID do cliente Jira
- Segredo do cliente: o segredo do cliente Jira
- URL de autorização: auth.atlassian.com/authorize Token URL: auth.atlassian.com/oauth/token
- Escopos: read:jira-work write:jira-work offline_access
Clique em Salvar.

Criação de uma conexão entre o Zendesk e o Jira

Em seguida, você criará uma conexão para permitir que o Zendesk acesse sua instância do Jira.

Dica: para obter mais informações sobre conexões, consulte Criação de conexões de API para o criador de bots e ações da assistência automática.

Como criar a conexão

Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Conexões > Conexões.
Clique em Criar conexão.
Preencha os seguintes campos:
- Nome da conexão: dê ao cliente um nome significativo para que você possa encontrá-lo facilmente mais tarde (por exemplo, Jira_oauth_token).
- Escolha um tipo de autenticação: OAuth 2.0
- Cliente: selecione o cliente OAuth do Jira que você registrou no Zendesk.
- Escopos: deixe em branco.
- Domínio permitido: api.atlassian.com
Clique em Salvar.
Você será guiado por uma tela OAuth para permitir que o Zendesk acesse sua instância do Jira.

Dica: se você não vir essa tela, verifique se ela não foi bloqueada pelo seu navegador.
Clique em Aceitar.
Você retornará à página de conexões, onde deverá ver uma nova entrada para sua nova conexão. Se a tela Criar conexão na qual você estava trabalhando ainda estiver aberta, pode fechá-la com segurança agora.

Criação de uma ação para criar um problema do Jira

No Zendesk, você criará uma ação que use o ponto de extremidade da API de problema do Jira para criar um novo problema.

Dica: Para obter mais informações sobre ações, consulte Criação e gerenciamento de ações para assistência automática.

Como criar a ação

Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Ações > Ações.
Clique em Criar ação.
No campo Nome, insira Criar tarefa de TI.
No campo Descrição, insira Cria uma tarefa de TI para a equipe executar e responde com o ID da tarefa.

Defina as três entradas a seguir:

Nome da entrada	Descrição da entrada	Tipo de entrada
name	Um nome curto para a tarefa.	cadeia de caracteres
description	Detalhamento completo da tarefa. Deve ter menos de 200 caracteres.	cadeia de caracteres
priority	A prioridade indica o grau de importância ou urgência da tarefa. Essa entrada é representada por um único número. Os valores válidos geralmente são 2 (problema de alto impacto ou urgência), 3 (problema padrão) e 4 (problema de baixo impacto ou urgência).	cadeia de caracteres

Observação: pode ser necessário modificar os valores numéricos usados para a prioridade para adequá-los à sua configuração específica do Jira.

Defina a Configuração da API:
- Método de solicitação: PUBLICAÇÃO
- URL do ponto de extremidade: https://api.atlassian.com/ex/jira/<YOUR_Jira_CLOUD_ID>/rest/api/2/issue
- Autenticação: selecione a conexão que você criou anteriormente.
Defina o Corpo:
```
{
"fields": {
   "summary": "{{name}}",
   "description": "{{description}}",
   "priority": {
      "id": "{{priority}}"
      },
   "issuetype": {
      "id": "10004"
      },
   "project": {
      "key": "ENQREQ"
      }
   }
}
```
Tenha em mente os seguintes pontos ao definir o corpo:
- Use o sinal de adição {+} para inserir os placeholders para priority, name e description.
- O valor da chave do projeto deve ser a chave que você identificou anteriormente.
- 10004 é o ID padrão para o tipo de problema Task do Jira. Dependendo da configuração do Jira, pode ser necessário usar outro ID. Saiba como encontrar os IDs do tipo de problema no Jira aqui.
Defina uma Saída:

Nome da saída Descrição da saída

task_id O ID legível por humanos para a nova tarefa.
Clique em Salvar.

Criação de um procedimento para orientar os agentes

Em seguida, você criará um procedimento que a assistência automática pode usar para ajudar a orientar os agentes.

Dica: para obter mais informações sobre procedimentos, consulte Criação e gerenciamento de procedimentos para assistência automática.

Como criar um procedimento

No Administrador do Conhecimento, clique em Procedimentos na barra lateral.
Clique em Criar procedimento.
No campo Nome, informe um nome descritivo, como Auxiliar de tarefas de TI.
No campo de corpo, insira o seguinte conteúdo:
Seu trabalho é ajudar a criar tarefas de TI para a equipe de TI.
Etapa 1: pergunte ao usuário com o que ele precisa de ajuda.
- Liste as seguintes solicitações comuns:
  - Pedir novo cartão de acesso
  - A bandeja da unidade não abre
  - Problema com a impressora
  - Outro
Etapa 2: obtenha mais detalhes sobre a tarefa.
- Pedir novo cartão de acesso: peça que o usuário forneça o nome, a descrição do cargo e a cor dos olhos.
- A bandeja da unidade não abre: pergunte ao usuário se ele tentou pressionar o botão na parte frontal da torre do PC. Pergunte se ele tentou clicar com o botão direito e ejetar.
- Problema com a impressora: pergunte o nome da impressora que está localizado na parte frontal da unidade. Peça mais detalhes sobre o problema.
- Outro: esse é um termo genérico para qualquer outro problema. Peça que o usuário explique qual é o problema.
Etapa 3: determine a prioridade.
1. Pergunte ao usuário qual o impacto que isso está tendo sobre ele e com que urgência o problema precisa ser corrigido.
2. Com base nessas informações, atribua uma prioridade 2 (alta), 3 (regular) ou 4 (baixa).
Etapa 4: resuma o problema e obtenha a confirmação do usuário.
1. Com base nas informações fornecidas, gere um nome e uma descrição para a tarefa. A descrição deve ter no máximo 200 caracteres.
2. Mostre o nome e a descrição ao usuário. Peça para ele confirmar.
  - Não crie a tarefa até que o usuário a confirme.
Etapa 5: crie a tarefa de TI.
1. Diga ao usuário que você vai criar a tarefa agora e que ele deve aguardar um momento. Por exemplo, "Obrigado por confirmar os detalhes. Vou registrar a tarefa com a equipe agora. Aguarde um momento, por favor."
2. Em seguida, crie uma tarefa de TI usando o nome, a descrição e a prioridade gerados nas etapas 3 e 4.
Etapa 6: compartilhe o ID da tarefa de TI.
- Após a criação da tarefa de TI, forneça o ID da tarefa ao usuário.
Etapa 7: Encerramento
- Agradeça ao usuário e continue a conversa.
Clique em Salvar.

Observação: pode ser necessário modificar os valores numéricos usados para prioridade na etapa 3 do procedimento de exemplo indicado anteriormente para adequá-los à sua configuração específica do Jira. Eles devem corresponder aos valores que você definiu para a entrada de prioridade ao criar a ação do Jira anteriormente nesta receita de fluxo de trabalho.

Teste do fluxo de trabalho

A maneira mais simples de testar seu fluxo de trabalho é usando o recurso de teste em um bot de conversa.

Como testar seu fluxo de trabalho em um bot de conversa

Em uma conversa de bot, abra ou crie uma resposta que inclua o tipo de etapa Transferir para o agente.
Na etapa Transferir para o agente, adicione a tag agent_copilot_enabled.
Na página de edição do bot de conversa, clique em Testar bot.
Para obter ajuda, consulte Teste do bot de conversa antes da publicação.
Inicie uma conversa com o bot usando uma frase relacionada à resposta que você criou.
Nessa janela do navegador, você desempenhará o papel do usuário final.
Em outra janela do navegador, abra o Espaço de trabalho do agente do Zendesk.
Aqui, você desempenhará o papel do agente. Você deve ver uma notificação pop-up com a nova conversa.
Como agente, siga as sugestões da assistência automática para responder ao usuário final.
Como usuário final, responda com as informações solicitadas.
Quando o problema do Jira for criado, abra o link para ver o novo problema.

Personalização do procedimento

Você pode personalizar ainda mais o procedimento e a ação nesta receita de fluxo de trabalho para atender às suas necessidades. Por exemplo:

Nas etapas 1 e 2 do procedimento, você pode alterar a lista de tarefas comuns e as etapas de solução de problemas para atender às suas necessidades específicas.
Na etapa 3 do procedimento, você pode adicionar diferentes níveis de prioridade. Se fizer isso, certifique-se de atualizar também a entrada na ação que você criou.
Você pode adicionar outras etapas para coletar mais informações que são incluídas nos campos correspondentes no problema do Jira (por exemplo, o ambiente em que o problema está ocorrendo ou dados para campos personalizados). Se fizer isso, certifique-se de atualizar também as entradas e o corpo na ação que você criou.

Você também pode criar um procedimento semelhante, como: “Posso obter uma atualização sobre minha tarefa de TI?”, para que os usuários finais se mantenham informados sobre o andamento de seus respectivos tickets. Para começar:

Crie uma nova ação que busque um problema do Jira com base no ID do problema e retorne informações úteis, como o status e a hora da última atualização, como saídas.
Crie um novo procedimento que solicite o ID do problema ao usuário e forneça a ele a atualização mais recente sobre o problema.

Solução de problemas

Se você encontrar problemas de autorização com o Jira:

Verifique se o usuário do Jira tem as permissões corretas para acessar o projeto.

Se você encontrar problemas com a ação:

Verifique as execuções da ação no registro de integração.
Certifique-se de que os valores numéricos na ação estejam de acordo com sua configuração do Jira (por exemplo, prioridade 2/3/4, tipo de problema 10004) e que você esteja usando a chave correta do projeto (por exemplo, ENGREQ).

Se o procedimento não estiver funcionando conforme o esperado:

Verifique se o nome e a descrição da ação e suas entradas e saídas são consistentes com o nome usado no procedimento.

Se a assistência automática não for iniciada no ticket:

Verifique se o usuário do Zendesk que você está usando no teste foi incluído nos grupos que têm acesso à assistência automática. Consulte Ativação e configuração do acesso à assistência automática.
Verifique se a resposta do seu bot de conversa inclui a tag agent_copilot_enabled.

Nome da saída	Descrição da saída
task_id	O ID legível por humanos para a nova tarefa.