Guia de Conexão Jira¶
Este guia de conexão orientará você sobre como conectar o Vinyl ao Jira. Jira é uma ferramenta de rastreamento de bugs usada no gerenciamento ágil de projetos e faz parte do pacote de produtos Atlassian.
Aviso
Depois de estabelecer uma conexão do Jira com o Vinyl, você precisa restringir a lógica usada para exibir os dados do Jira na página para que ele não consulte todos os registros. Não fazer isso pode fazer com que o aplicativo Vinyl pareça não responder.
Pré-requisitos¶
- Você deve ter o Vinyl 3.3+ instalado
- Você deve ter uma conta Atlassian
- Você deve ter um token API válido para a conta Atlassian
Configuração no Atlassian¶
Crie um token de API da sua conta Atlassian:
- Faça login em https://id.atlassian.com/manage-profile/security/api-tokens
- Clique em Criar token de API
- Insira um Rótulo claro e conciso para o token e clique em Criar
- Clique em Copiar para área de transferência e cole o token em um local seguro para salvar. Esta informação será necessária nas etapas de configuração do Vinyl.
Configuração em Vinyl¶
Crie um Servidor de Dados Jira¶
- Navegue até o Vinyl IDE
- Clique em Servidores de dados no menu Conectar
-
Clique no botão + Servidor e forneça as seguintes informações:
- Nome do Servidor: Nome identificável para conexão do servidor. Por exemplo: Jira
- Tipo: Jira
- Url: Domínio base para a instância do Atlassian Cloud. Por exemplo:
https://yourcompany.atlassian.net/
-
Clique em Salvar
- Clique no botão Configurações avançadas
- Clique em Editar
-
Insira o token da API no campo Avançado, usando o formato
APIToken=<yourAPIToken>
-
Clique em Salvar
Importe os Dados do Jira para Exibição em Vinyl¶
- Navegue até o Vinyl IDE
- Clique em Servidores de dados no menu Conectar
- Localize a fonte de dados Jira e clique no botão Detalhes no painel direito
- Clique no botão Importar
-
Determine qual esquema você deseja importar:
- Importar do Padrão: Permite importar apenas as tabelas especificadas neste campo. Os prefixos podem ser usados para importar apenas um subconjunto de tabelas, por exemplo
MyApp_*
importará apenas tabelas começando comMyApp_
. Deixar o campo em branco importará todas as tabelas. - Clique em Continuar quando solicitado. O Vinyl executará a importação como uma tarefa em segundo plano.
- As guias Tabelas, Visualizações e Procedimentos listam todas as opções disponíveis junto com os botões Importar esquema correspondentes.
- Importar do Padrão: Permite importar apenas as tabelas especificadas neste campo. Os prefixos podem ser usados para importar apenas um subconjunto de tabelas, por exemplo
Depois de importar os dados, você pode criar uma lógica de negócios para usar nos painéis e exibir os dados do Jira nas páginas do seu aplicativo Vinyl.
Solução de Problemas¶
- Se você não vir nenhuma opção disponível para a fonte de dados do Jira no botão Vinyl Importar, verifique se inseriu um token de API válido.
- Se o Vinyl parecer não responder ao tentar carregar uma página de aplicativo com dados do Jira ou se o Jira exibir uma mensagem "Algo deu errado", revise a lógica que está sendo usada para garantir que ela esteja restringindo o retorno dos dados a critérios mais razoáveis.