Esta página foi traduzida pela API Cloud Translation.

Jira Cloud

Com o conector do Jira Cloud, é possível realizar operações de inserção, exclusão, atualização e leitura nos dados do Jira, que são modelados como um banco de dados.

Versões compatíveis

O conector do Jira Cloud usa as versões 2 e 3 da API REST do Jira Cloud. Eles são gerenciados internamente, e você não precisa fazer outras configurações.

Antes de começar

Antes de usar o conector do Jira Cloud, faça o seguinte:

No seu projeto do Google Cloud, faça o seguinte:
- Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
- Conceda o papel do IAM roles/connectors.admin ao usuário que está configurando o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.
- Ative os seguintes serviços:
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Para entender como ativar os serviços, consulte Como ativar serviços.
Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, faça o seguinte:

No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
Acessar a página "Conexões"
Clique em + CRIAR NOVO para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Para conferir a lista de todas as regiões com suporte, consulte Locais.
2. Clique em PRÓXIMA.
Na seção Detalhes da conexão, faça o seguinte:
1. Conector: selecione Jira Cloud na lista suspensa de conectores disponíveis.
2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
3. No campo Nome da conexão, insira um nome para a instância de conexão
  Os nomes de conexão precisam atender aos seguintes critérios:
  - Os nomes de conexões podem usar letras, números ou hifens.
  - As letras precisam ser minúsculas.
  - Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das conexões não podem exceder 49 caracteres.
  - Para conectores que aceitam inscrição em eventos, os nomes de conexão não podem começar com o prefixo "goog".
4. Como opção, insira uma Descrição para a instância de conexão.
5. Se quiser, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
7. Para usar a conexão em assinaturas de eventos, selecione Ativar assinatura de eventos. Ao selecionar essa opção, as seguintes opções vão aparecer:
  - Ativar assinatura de eventos com entidade e ações: selecione essa opção para usar a conexão para assinatura de eventos e operações de conector (entidades e ações).
  - Ativar somente a assinatura de eventos: selecione essa opção para usar a conexão apenas para assinatura de eventos. Se você selecionar essa opção, clique em Próxima e configure a inscrição no evento.
8. Opcionalmente, defina as Configurações do nó de conexão:
  - Número mínimo de nós: digite o número mínimo de nós de conexão.
  - Número máximo de nós: digite o número máximo de nós de conexão.
  Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.
9. (Opcional) Na seção Configurações avançadas, marque a caixa de seleção Usar proxy para configurar um servidor proxy para a conexão e defina os seguintes valores:
10. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
11. Clique em PRÓXIMA.
Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
1. Tipo de destino: selecione um Tipo de destino.
  - Endereço do host: especifique o nome do host ou o endereço IP do destino.
    Observação:se você estiver especificando um nome de host, inclua o URL e o protocolo (HTTP ou HTTPS).
    
    Se você quiser estabelecer uma conexão particular com seu back-end, faça o seguinte:
    - Crie um anexo do serviço PSC.
    - Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
  Para inserir outros destinos, clique em +ADICIONAR DESTINO.
2. Clique em PRÓXIMA.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  A conexão do Jira Cloud aceita os seguintes tipos de autenticação:
  - Nome de usuário e senha
2. Clique em PRÓXIMA.
Se você tiver ativado a assinatura de eventos, a seção Detalhes da assinatura de eventos vai aparecer na página de criação da conexão. Para entender como configurar os detalhes da assinatura de eventos, consulte Configurar assinatura de eventos.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

Configurar assinatura de evento

Se você ativou a assinatura de eventos, insira os seguintes valores na seção Detalhes da assinatura de eventos:

Selecione um Tipo de destino.
- Endereço do host: insira o URL de registro do seu sistema de back-end no campo host.
Insira os detalhes de autenticação.
1. Nome de usuário: digite o nome de usuário.
2. Token da API: selecione o secret do Secret Manager que contém o token da API.
3. Versão do secret: selecione a versão do secret.
Selecione Ativar conectividade particular para uma conectividade segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, precisará executar mais etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinatura de eventos.
Insira a configuração de mensagens inativas. Se você configurar a carta inativa, a conexão gravará os eventos não processados no tópico do Pub/Sub especificado. Digite os seguintes detalhes:
1. ID do projeto de dead-letter : o ID do projeto do Google Cloud em que você configurou o tópico de dead-letter do Pub/Sub.
2. Tópico de mensagens mortas : o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
Se você quiser usar um proxy para se conectar ao back-end (para inscrição em eventos), insira os seguintes detalhes:

Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Selecione um dos seguintes tipos de autenticação:
- Sempre: a conexão está sempre com SSL ativado para assinatura de eventos.
- Nunca: a conexão não está com SSL ativado para inscrição em eventos.
Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
- Básico: autenticação HTTP básica.
Usuário proxy: digite o nome de usuário a ser usado para autenticar com o servidor proxy.
Senha de proxy: selecione a chave secreta do Secret Manager da senha do usuário.
Versão do secret: selecione a versão do secret.
Na seção Servidor proxy, insira os detalhes do servidor proxy.
1. Clique em + Adicionar destino e selecione Tipo de destino como Endereço do host.
2. Digite o nome do host ou o endereço IP do servidor proxy e o número da porta dele.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

Nome de usuário e senha
- Nome de usuário: o nome de usuário do Jira Cloud a ser usado para a conexão.
- Token da API: a senha do nome de usuário será um token da API. Selecione o Secret do Secret Manager que contém o token de API associado ao nome de usuário do Jira Cloud.
Código de autorização OAuth 2.0

ID do cliente: ID do cliente conforme fornecido pelo aplicativo externo.
Escopos: escopos de permissão. Os escopos offline_access e read:jira-user são obrigatórios para criar uma conexão. Para entender como os escopos funcionam e ver todos os disponíveis para o Jira Cloud, consulte Escopos.
Chave secreta do cliente: selecione a chave Gerenciador de secrets. É necessário criar a chave secreta do Secret Manager antes de configurar esta autorização.
Versão do secret: a versão do secret do cliente no Secret Manager.
ID da nuvem: especifique o ID da nuvem do site da Atlassian. Para informações sobre como conseguir o ID do Cloud, consulte ID do Cloud.

Para o tipo de autenticação Authorization code, depois de criar a conexão, execute mais algumas etapas para configurar a autenticação. Para mais informações, consulte Etapas adicionais após a criação da conexão.

Observação:se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de configuração no aplicativo Jira Cloud, será necessário autorizar novamente a conexão do Jira Cloud. Para entender como fazer isso, consulte Reautorização do código de autorização.

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas etapas adicionais depois de criar a conexão:

Na página "Conexões", localiza a conexão recém-criada.
O Status do novo conector será Autorização necessária.
Clique em Autorização necessária.
O painel Editar autorização é exibido.
Copie o valor de URI de redirecionamento para seu aplicativo externo.
Verifique os detalhes da autorização.
Clique em Autorizar.
Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Reautorização do código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de configuração no aplicativo Jira Cloud, será necessário autorizar novamente a conexão do Jira Cloud. Para reautorizar uma conexão, siga estas etapas:

Clique na conexão desejada na página "Conexões".
A página de detalhes da conexão será aberta.
Clique em Editar para mudar os detalhes da conexão.
Verifique os detalhes do Código de autorização do OAuth 2.0 na seção Autenticação.
Se necessário, faça as mudanças necessárias.
Clique em Salvar. Isso leva você à página de detalhes da conexão.
Clique em Editar autorização na seção Autenticação. O painel Autorizar é exibido.
Clique em Autorizar.
Se a autorização for concluída, o status da conexão será definido como Ativo na página "Conexões".

Limitações do sistema

O conector do Jira Cloud pode processar no máximo 10 transações por segundo, por nó, e limita qualquer transação além desse limite. Por padrão, o Integration Connectors aloca dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação:o número de nós do Integration Connectors será escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processar menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente de pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição da conexão.
Se você for um cliente por assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar o número mínimo de nós para melhorar a capacidade de processamento, recomendamos que você verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: listar problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação LIST e clique em Concluído.
Na seção Entrada de tarefa da tarefa Conectores, é possível definir a filterClause de acordo com a exigência do cliente.

Use aspas simples (') para incluir o valor de uma filterClause, como CreatorEmail = 'cruz@altostrat.com'. Use o filterClause para filtrar registros com base nas colunas.

Em algumas entidades, apenas a operação de lista não pode buscar dados. Nessas entidades, é possível usar "filetClause".

Exemplo: receber problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação GET e clique em Concluído.
Defina o ID da entidade como 10000, que é o ID da chave a ser transmitido para problemas. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira 10000 no campo Valor padrão.

O valor do ID da entidade precisa ser transmitido diretamente, como 10000. Aqui, 10000 é o valor exclusivo da chave primária. A operação "Get" só pode ser realizada em entidades com chave primária exclusiva.

Exemplo: excluir problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação DELETE e clique em Concluído.
Defina o ID da entidade como 10000, que é a chave a ser transmitida. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira 10000 no campo Valor padrão.

A operação de exclusão só pode ser realizada em entidades com chave primária exclusiva.

Exemplo: criar IssueTypes

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione IssueTypes na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "task123456",
  "Description": "New description is added."
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": "10041"
}
```

Exemplo: criar problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
  {
    "IssueTypeName": "Subtask", 
    "ProjectName": "kanban4", 
    "Summary": "Summary Added", 
    "ParentKey": "KN-6" 
  }
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": 10071.0
}
```

Exemplo: criar sprints

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Sprints" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "PROJ Sprint GCPcloud",
  "State": "future",
  "Goal": null,
  "OriginBoardId": 2.0,
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": 23.0
}
```

Exemplo: criar comentários

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Comentários" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "IssueId": 10001.0,
  "Body": "Adding comments to above ID by editing it"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": 10023.0,
  "IssueId": null
}
```

Exemplo: criar usuários

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Usuários" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "GroupName": null,
  "DisplayName": "Charlie",
  "EmailAddress": "charlie@altostrat.com",
  "Active": true,
  "TimeZone": null,
  "Locale": "en_US",
  "AccountType": "atlassian"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa de conectores terá um valor semelhante a este:
```
{
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}
```

Exemplo: criar registros de trabalho

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Registros de trabalho" na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "IssueKey": "GJCT-1",
  "Started": "2023-06-10 08:08:08",
  "TimeSpent": "2000"
}
```
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": "41718",
  "IssueId": 10000.0
}
```

Exemplo: atualizar IssueTypes

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione IssueTypes na lista Entity.
Selecione a operação Update e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "NEW_TASK",
  "Description": "New Description"
}
```
Defina o ID da entidade como a entidade de IssueTypes. Para definir o ID da entidade, clique em entityId e insira 10038 no campo Valor padrão.
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "Id": "10038"
}
```

Exemplo: problemas de atualização

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Problemas" na lista Entity.
Selecione a operação Update e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "AssigneeAccountId": "61d572aa7c6f9800705289a1",
  "AssigneeName": "Charlie c"
}
```
Defina o ID da entidade como a entidade dos problemas. Para definir o ID da entidade, clique em entityId e insira 10024 no campo Valor padrão.
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
  "AssigneeDisplayName": "Charlie Cruz"
}
```

Exemplo: atualizar sprints

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Sprints" na lista Entity.
Selecione a operação Update e clique em Concluído.
Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "PROJ Sprint GCP_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
} 
```
Defina o ID da entidade como a entidade das sprints. Para definir o ID da entidade, clique em entityId e insira 2 no campo Valor padrão.
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
}
```

Exemplo: atualizar comentários

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Comentários" na lista Entity.
Selecione a operação Update e clique em Concluído.

Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

{
  "Name": "PROJ Sprint GCPcloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}

Defina o ID da entidade como a entidade dos comentários. Para definir o ID da entidade, clique em entityId e insira 2 no campo Valor padrão.
Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
{
}
```

Criar conexões usando o Terraform

Use o recurso do Terraform para criar uma conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um modelo de exemplo do Terraform para criação de conexão, consulte modelo de exemplo.

Ao criar essa conexão usando o Terraform, defina as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
proxy_enabled	BOOLEAN	Falso	Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar o proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticar no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado ao se conectar ao proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do Jira Cloud em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte Tarefa "Conectores".
Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Saiba como ver os registros do conector.