Esta página foi traduzida pela API Cloud Translation.

Jira Cloud

O conetor do Jira Cloud permite-lhe realizar operações de inserção, eliminação, atualização e leitura em dados do Jira modelados como uma base de dados.

Versões suportadas

O conetor do Jira Cloud usa as versões 2 e 3 da API REST do Jira Cloud. Estas são geridas internamente e não tem de fazer configurações adicionais.

Antes de começar

Antes de usar o conector do Jira Cloud, faça as seguintes tarefas:

No seu projeto do Google Cloud:
- Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
- Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
- Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.
- Ative os seguintes serviços:
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (API Connectors)
  Para saber como ativar serviços, consulte o artigo Ativar serviços.
Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.
Aceda à página Ligações
Clique em + CRIAR NOVO para abrir a página Criar associação.
Na secção Localização, escolha a localização para a ligação.
1. Região: selecione uma localização na lista pendente.
  Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.
2. Clique em SEGUINTE.
Na secção Detalhes da associação, conclua o seguinte:
1. Conector: selecione Jira Cloud na lista pendente de conectores disponíveis.
2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
3. No campo Nome da ligação, introduza um nome para a instância de ligação.
  Os nomes das associações têm de cumprir os seguintes critérios:
  - Os nomes das associações podem usar letras, números ou hífenes.
  - As letras têm de ser minúsculas.
  - Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das associações não podem exceder 49 carateres.
  - Para os conetores que suportam a subscrição de eventos, os nomes das associações não podem começar com o prefixo "goog".
4. Opcionalmente, introduza uma Descrição para a instância de associação.
5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
7. Para usar a associação para subscrições de eventos, selecione Ativar subscrição de eventos. Se selecionar esta opção, são apresentadas as seguintes opções:
  - Ativar subscrição de eventos com entidade e ações: selecione esta opção para usar a associação para a subscrição de eventos e as operações do conetor (entidades e ações).
  - Ativar apenas subscrição de eventos: selecione esta opção para usar a associação apenas para a subscrição de eventos. Se selecionar esta opção, clique em Seguinte e, de seguida, configure a subscrição de eventos.
8. Opcionalmente, configure as definições do nó de associação:
  - Número mínimo de nós: introduza o número mínimo de nós de ligação.
  - Número máximo de nós: introduza o número máximo de nós de ligação.
  Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.
9. (Opcional) Na secção Definições avançadas, selecione a caixa de verificação Usar proxy para configurar um servidor proxy para a ligação e configurar os seguintes valores:
10. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
11. Clique em SEGUINTE.
Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
1. Tipo de destino: selecione um Tipo de destino.
  - Endereço do anfitrião: especifique o nome do anfitrião ou o endereço IP do destino.
    Nota: se estiver a especificar um nome de anfitrião, tem de especificar o URL juntamente com o protocolo (HTTP ou HTTPS).
    
    Se quiser estabelecer uma ligação privada ao seu back-end, faça o seguinte:
    - Crie uma associação de serviço do PSC.
    - Crie uma associação de ponto final e, em seguida, introduza os detalhes da associação de ponto final no campo Endereço do anfitrião.
  Para introduzir destinos adicionais, clique em +ADICIONAR DESTINO.
2. Clique em SEGUINTE.
Na secção Autenticação, introduza os detalhes de autenticação.
1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.
  Os seguintes tipos de autenticação são suportados pela ligação do Jira Cloud:
  - Nome de utilizador e palavra-passe
2. Clique em SEGUINTE.
Se tiver ativado a subscrição de eventos, a secção Detalhes da subscrição de eventos é apresentada na página de criação da associação. Para compreender como configurar os detalhes da subscrição de eventos, consulte o artigo Configure a subscrição de eventos.
Rever: reveja os detalhes da ligação e da autenticação.
Clique em Criar.

Configure a subscrição de eventos

Se ativou a subscrição de eventos, introduza os seguintes valores na secção Detalhes da subscrição de eventos:

Selecione um Tipo de destino.
- Endereço do anfitrião: introduza o URL de registo do seu sistema de back-end no campo anfitrião.
Introduza os detalhes de autenticação.
1. Nome de utilizador: introduza o nome de utilizador.
2. Token de API: selecione o segredo do Secret Manager que contém o token de API.
3. Versão do Secret: selecione a versão do Secret.
Selecione Ativar conetividade privada para uma conetividade segura entre a sua aplicação de back-end e a sua ligação. Se selecionar esta opção, tem de realizar passos de configuração adicionais depois de criar a associação. Para mais informações, consulte o artigo Conetividade privada para subscrição de eventos.
Introduza a configuração de mensagens não entregues. Se configurar a fila de mensagens rejeitadas, a ligação escreve os eventos não processados no tópico Pub/Sub especificado. Introduza os seguintes detalhes:
1. ID do projeto de mensagens não entregues: o ID do projeto do Google Cloud onde configurou o tópico Pub/Sub de mensagens não entregues.
2. Tópico de mensagens não entregues: o tópico do Pub/Sub onde quer escrever os detalhes do evento não processado.
Se quiser usar um proxy para estabelecer ligação ao seu back-end (para a subscrição de eventos), introduza os seguintes detalhes:

Tipo de SSL do proxy: o tipo de SSL a usar quando se liga ao servidor proxy. Selecione qualquer um dos seguintes tipos de autenticação:
- Sempre: a ligação está sempre ativada com SSL para a subscrição de eventos.
- Nunca: a ligação não tem o SSL ativado para a subscrição de eventos.
Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Os seguintes tipos de autenticação são suportados:
- Básica: autenticação HTTP básica.
Utilizador do proxy: introduza o nome de utilizador a usar para a autenticação junto do servidor proxy.
Palavra-passe do proxy: selecione o segredo do Secret Manager da palavra-passe do utilizador.
Versão do Secret: selecione a versão do Secret.
Na secção Servidor proxy, introduza os detalhes do servidor proxy.
1. Clique em + Adicionar destino e, de seguida, selecione o Tipo de destino como Endereço do anfitrião.
2. Introduza o nome de anfitrião ou o endereço IP do servidor proxy e o número da porta do servidor proxy.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

Nome de utilizador e palavra-passe
- Nome de utilizador: o nome de utilizador do Jira Cloud a usar para a ligação.
- Token de API: a palavra-passe para o nome de utilizador é um token de API. Selecione o segredo do Secret Manager que contém o token da API associado ao nome de utilizador do Jira Cloud.
OAuth 2.0 – Código de autorização

ID de cliente: ID de cliente conforme fornecido pela sua aplicação externa.
Âmbitos: âmbitos de autorização. Os âmbitos offline_access e read:jira-user são necessários para criar uma associação. Para compreender como funcionam os âmbitos e ver todos os âmbitos disponíveis para o Jira Cloud, consulte o artigo Âmbitos.
Segredo do cliente: selecione o segredo do Secret Manager. Deve ter criado o segredo do Secret Manager antes de configurar esta autorização.
Versão do Secret: versão do Secret do Secret Manager para o segredo do cliente.
ID do Cloud: especifique o ID do Cloud do site do Atlassian. Para obter informações sobre como obter o Cloud ID, consulte Cloud ID.

Para o Authorization code tipo de autenticação, depois de criar a associação, deve efetuar alguns passos adicionais para configurar a autenticação. Para mais informações, consulte Passos adicionais após a criação da associação.

Nota: se estiver a usar o tipo de autenticação Authorization code e tiver feito alterações de configuração na sua aplicação Jira Cloud, tem de voltar a autorizar a ligação ao Jira Cloud. Para saber como autorizar novamente, consulte o artigo Autorização novamente para o código de autorização.

Passos adicionais após a criação da associação

Se selecionou OAuth 2.0 - Authorization code para a autenticação, tem de realizar os seguintes passos adicionais após criar a associação:

Na página Ligações, encontre a ligação criada recentemente.
Tenha em atenção que o Estado do novo conetor é Autorização necessária.
Clique em Autorização obrigatória.
É apresentado o painel Editar autorização.
Copie o valor do URI de redirecionamento para a sua aplicação externa.
Valide os detalhes da autorização.
Clique em Autorizar.
Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Nova autorização para o código de autorização

Se estiver a usar o tipo de autenticação Authorization code e tiver feito alterações de configuração na sua aplicação Jira Cloud, tem de voltar a autorizar a ligação ao Jira Cloud. Para autorizar novamente uma associação, siga estes passos:

Clique na associação necessária na página Associações.
É apresentada a página de detalhes da associação.
Clique em Editar para editar os detalhes da associação.
Valide os detalhes de OAuth 2.0 – Código de autorização na secção Autenticação.
Se necessário, faça as alterações necessárias.
Clique em Guardar. Esta ação direciona para a página de detalhes da associação.
Clique em Editar autorização na secção Autenticação. É apresentado o painel Autorizar.
Clique em Autorizar.
Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Limitações do sistema

O conetor do Jira Cloud pode processar um máximo de 10 transações por segundo, por nó, e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

Se for cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

Exemplos de operações de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

Exemplo: problemas com listas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Problemas na lista Entity.
Selecione a operação LIST e, de seguida, clique em Concluído.
Na secção Task Input da tarefa Connectors, pode definir o filterClause de acordo com o requisito do cliente.

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

Em algumas entidades, apenas a operação de lista não consegue obter dados. Em tais entidades, pode usar filetClause.

Exemplo: obter problemas

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Problemas na lista Entity.
Selecione a operação GET e, de seguida, 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 secção Entrada da tarefa da tarefa Conetores, clique em EntityId e, em seguida, introduza 10000 no campo Valor predefinido.

O valor do ID da entidade tem de ser transmitido diretamente, por exemplo, 10000. Aqui, 10000 é o valor da chave principal exclusivo. A operação Get só pode ser realizada em entidades com uma chave principal única.

Exemplo – Problemas de eliminação

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

A operação de eliminação só pode ser realizada em entidades com uma chave principal única.

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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "Id": 10023.0,
  "IssueId": null
}
```

Exemplo: criar utilizadores

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Utilizadores na lista Entity.
Selecione a operação Create e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 ao seguinte:
```
{
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}
```

Exemplo: criar registos de tempo

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Registos de trabalho na lista Entity.
Selecione a operação Create e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
```
{
  "Name": "NEW_TASK",
  "Description": "New Description"
}
```
Defina o ID da entidade para a entidade dos IssueTypes. Para definir o ID da entidade, clique em entityId e, de seguida, introduza 10038 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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, de seguida, introduza 10024 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
  "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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 dos sprints. Para definir o ID da entidade, clique em entityId e, de seguida, introduza 2 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
}
```

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, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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, de seguida, introduza 2 no campo Valor predefinido.
Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:
```
{
}
```

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

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

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
proxy_enabled	BOOLEAN	Falso	Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma palavra-passe a usar para autenticar no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL

Use a ligação do Jira Cloud numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

Compreenda como suspender e retomar uma associação.
Compreenda como monitorizar a utilização do conector.
Compreenda como ver os registos do conetor.