Configuração da integração do Zendesk Support para o Jira

A integração para o Jira incentiva a colaboração entre as equipes de produto e de suporte. A integração v4 para o Jira oferece suporte ao Atlassian Jira Cloud (OnDemand), Jira Data Center e ao Jira Server (OnPremise) versão 7x ou superior.

Os tópicos abordados neste artigo são:

• Requisitos de instalação
• Instalação e configuração da integração
• Restrição de acesso ao aplicativo Jira Cloud
• Adição de campos ao aplicativo do Jira no Zendesk Support
• Uso da opção do usuário dedicado à integração
• Instruções específicas do Jira Server
• Reinstalação da integração

Tópicos relacionados:

• Uso da integração do Zendesk Support para o Jira
• Restrição de acesso a projetos na integração para o Jira
• Atualização de um ticket quando o status de um problema no Jira é alterado

Requisitos de instalação

Você deve ter permissões de administrador no Jira e no Zendesk Support para configurar a integração.

Além disso, você deve atender aos seguintes requisitos:

• Ser membro dos grupos jira-administrators e jira-software-users
• Não possuir esquemas de permissão que o impeçam de criar e atualizar projetos
• O campo reporter deve estar na tela Create Issue para os respectivos projetos
• Usar o Jira Internal Directory como seu diretório de usuário
• Os complementos do Atlassian devem ter permissão para acessar seus projetos no Jira. Por padrão, esse componente está ativado. Para verificar isso, consulte a página Project Permissions para cada projeto no Jira. As várias ações do projeto devem ter um Project Role chamado Project Role (atlassian-addons-project-access)
• Os cookies de terceiros devem estar habilitados. No entanto, se os cookies de terceiros precisarem permanecer desativados em seu sistema, adicione jiraplugin.zendesk.com à lista de exceções de conteúdo

Instalação e configuração da integração

O processo de configuração da integração envolve a instalação do Zendesk Support para o aplicativo do Jira no Atlassian Marketplace em sua conta do Jira e a configuração do aplicativo.

Como instalar e configurar a integração

1. No Jira, clique em Apps na barra de navegação superior e selecione Find new apps.
2. Na página Marketplace apps, pesquise por Zendesk.
3. Localize e clique na entrada Zendesk Support for Jira dos resultados de pesquisa.
4. Clique em Get app.

   

5. Clique em Get it now.
6. Quando a caixa de notificação de instalação concluída com êxito for exibida, clique em Configure.
7. Insira seu subdomínio da Zendesk. Por padrão, a caixa de seleção Create a new dedicated Zendesk user for this integration vem selecionada. Sugerimos que você use esse recurso para permitir que todas as transferências do Jira para o Zendesk Support não venham do administrador que configurou a integração, mas de um usuário dedicado. Isso criará automaticamente um novo usuário administrador em sua conta Zendesk que será utilizado apenas pela integração para o Jira. Para obter mais informações, consulte Uso da opção do usuário dedicado à integração.
8. Clique em Authenticate.
9. Uma segunda página do navegador é exibida solicitando que você entre em sua conta Zendesk. Insira suas credenciais de acesso. A página será fechada.
10. Na página de configurações do aplicativo, selecione os detalhes a exibir nos problemas do Jira vinculados.

    

11. Clique em Salvar.
12. Se você está usando o Jira Cloud, pode verificar o funcionamento da integração adicionando um usuário add_on_zendesk_for_jira ao grupo jira-users no administrador do Jira.

No Jira Cloud, a integração cria um usuário administrador grátis chamado Zendesk for Jira. É possível alterar o avatar do usuário na página Profile.

Restrição de acesso ao aplicativo Jira Cloud

Se você desejar controlar o acesso ao aplicativo (por exemplo, administradores ou apenas agentes), é possível fazer a alteração na instância do produto Zendesk.

Como restringir o acesso ao aplicativo Jira Cloud

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações.
2. Na aba Instalados no momento, localize o aplicativo Jira Cloud.
3. Passe o mouse sobre o aplicativo Jira Cloud. Usando o menu suspenso no canto direito do ícone do aplicativo, selecione Alterar configurações.
4. Em Instalação, marque a caixa de seleção Habilitar restrições de função?.
5. Clique na caixa de texto Restrições de função e selecione as funções que terão permissão para usar o aplicativo.
6. Clique em Atualizar para salvar as alterações.

Suas equipes já podem começar a colaborar usando o Zendesk e o Jira. Para descobrir como fazer isso, consulte Uso da integração do Zendesk Support para o Jira.

Adição de campos ao aplicativo do Jira no Zendesk Support

Quando você cria um problema do Jira de um ticket do Zendesk Support, precisa inserir os detalhes do problema em questão no formulário Criar novo problema do Jira:

Esse formulário contém vários campos padrão:

• Projeto
• Tipo de problema
• Relatador
• Atribuído
• Resumo
• Descrição

Esses campos padrão não podem ser removidos. No entanto, é possível incluir campos adicionais do Jira nesse formulário, sejam campos pré-existentes ou personalizados.

Para obter mais informações, consulte Specifying field behavior no website da Atlassian.

Configuração do formulário de criação do problema

Você pode definir os campos do Jira que os agentes podem ver criando um novo problema do Support, uma melhoria significativa no aplicativo do Jira v4.

Esses campos são específicos para um determinado projeto ou tipo de problema do Jira. Os campos do problema definidos como “required” (obrigatórios) no Jira serão exibidos no formulário independentemente das configurações desse formulário.

Observação: apenas os administradores do Support podem configurar esses campos para seus agentes.

Uso da opção do usuário dedicado à integração

Se você escolher criar um usuário dedicado à integração em sua conta do Zendesk Support, será criado automaticamente um novo usuário confirmado (Jira Integration) com um endereço de e-mail ([e-mail]). Esta conta de usuário é totalmente gerenciada pela integração e será suspensa se a integração for removida.

Observação:

• Esta opção de usuário dedicado à integração exige uma licença disponível para o agente. Uma vez em uso, essa licença não estará disponível para outros agentes.
• A conta do administrador que instalou a integração para o Jira e o usuário dedicado à integração precisam ter permissões de administrador e estar ativos para que a integração funcione. Se você suspender ou fizer o downgrade da conta do administrador ou do usuário dedicado à integração, a integração não funcionará.

Após o término do processo de autenticação e criação, o serviço de integração estará pronto para o uso. Todos os comentários e ações de sincronização de campos serão realizados como se tivessem sido feitos pelo usuário dedicado à integração.

Se você quiser parar de utilizar o usuário dedicado à integração, poderá desconectar a integração no Jira. Uma vez desconectado, o Jira parará de utilizar o usuário dedicado à integração. O usuário dedicado à integração na conta do Zendesk Support sofrerá um downgrade para usuário final e será suspenso. Desinstalar o plug-in também resultará em downgrade e suspensão do usuário.

Como desconectar o usuário dedicado à integração

1. No Jira, clique em Jira settings e visite Apps > Manage apps.
2. Clique para expandir o aplicativo Zendesk Support for Jira e em Configure.
3. Clique em Disconnect para desconectar seu subdomínio.

   

4. Insira novamente o seu subdomínio e desmarque a opção para criar um usuário dedicado à integração.
5. Clique em Authenticate para autenticar novamente seu subdomínio.

Instruções específicas do Jira Server

Ainda que os recursos e os processos de configuração da integração do Jira Cloud e Jira Server com o Zendesk Support sejam parecidos, quando se trata de instalação no Jira Server, você precisará atender aos requisitos a seguir:

• Para garantir que o Zendesk estabeleça a conexão com o seu Jira Server, é necessário que você crie uma lista de autorização dos itens a seguir:
  • Os endereços IP para a sua conta Zendesk. Para obter informações sobre como obtê-los, consulte "Obtenção de endereços IP" em Configuração do firewall para uso com o Zendesk
  • Os intervalos de endereços IP da integração do Jira (Pod 19) em Obtenção de endereços IP para outros produtos Zendesk.
• Recomendamos o uso da criptografia SSL para proteger a comunicação entre o Jira e o Zendesk, principalmente em ambientes de produção. Se o SSL estiver ativado, você deve possuir uma pilha completa de certificado de SSL de uma autoridade de certificação. Não há suporte para certificados autoassinados. O certificado intermediário normalmente não é instalado no servidor do Jira.
• Certifique-se de que a porta correta esteja aberta (normalmente a 80/8080/443 dependendo das configurações de SSL) em sua rede para tráfegos de entrada e de saída entre Zendesk e Jira.
• Na configuração do complemento no Jira, a "URL base do Jira" pode não ser a mesma URL que você usa para acessar o Jira em seu servidor privado. A URL base do Jira precisa ser um endereço de acesso público para que a Zendesk a use para fazer as solicitações de rede para sua instância do Jira. Você pode conectar esse endereço acessível publicamente ao endereço do seu servidor particular via NAT ou proxy reverso.
• Se você configurar o complemento em um ambiente de servidor do Jira para teste ou sandbox e migrar o ambiente para produção posteriormente, não copie o arquivo zendesk_plugin.properties por cima. Replicar ou substituir esse arquivo em um ambiente à parte pode impedir o funcionamento da Integração do Jira.
• O complemento da Zendesk no Jira precisa ser executado com privilégios administrativos. Sugerimos que você crie uma conta dedicada conforme a seguir e adicione-a aos grupos jira-administrators e jira-software-users.

  Nome completo: Zendesk for Jira

  Nome de usuário: addon_zendesk

O nome de usuário acima é o que a integração procura por padrão. Se o nome não existir, ele tentará usar a conta do administrador que instalou o complemento e, se isso falhar, será usada a primeira conta de administrador que estiver disponível.

Observação: se você estiver tendo problemas, desconecte e desinstale a integração do Jira e reinstale com um usuário com privilégios de administrador nos dois sistemas.

Reinstalação da integração

Normalmente, a reinstalação da integração é necessária nos casos a seguir:

• Na alteração do usuário de integração
• Na alteração da instância do Jira vinculada à sua conta do Zendesk Support
• Na alteração da instância do Zendesk Support vinculada à sua instância do Jira (incluindo sandboxes)
• No restabelecimento da conexão entre o produto Zendesk e o Jira após a reinicialização do servidor do Jira ou da limpeza do cache de plug-in

Se você está reintegrando as mesmas contas da Zendesk e Jira, seus dados de problemas vinculados permanecem intactos.

Como reinstalar a integração

1. No JIRA, navegue até Apps > Manage your apps.
2. Clique no menu acordeão Zendesk Support for JIRA e selecione Configure.
3. Selecione Disconnect.
4. Volte à página de gerenciamento de aplicativos, clique no menu acordeão Zendesk Support for Jira e em Uninstall.
5. Conclua o processo de configuração. Consulte Instalação e configuração da integração.